Skip to content

Commit 774932e

Browse files
committed
docs: update README to clarify cryptographic backend integration and build prerequisites
1 parent 058dcac commit 774932e

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This project provides a C implementation of AWS Signature Version 4 (SigV4) sign
44

55
## Features
66
- AWS SigV4 signing for HTTP requests
7-
- OpenSSL integration for cryptographic operations
7+
- Pluggable cryptographic backend integration (not limited to OpenSSL)
88
- Simple API for integration into C projects
99
- Example usage included
1010
- System header configurability via `SIGV4_SYSTEM_HEADER`
@@ -13,11 +13,16 @@ This project provides a C implementation of AWS Signature Version 4 (SigV4) sign
1313

1414
### Prerequisites
1515
- GCC or compatible C compiler
16-
- OpenSSL development libraries
1716
- `pkg-config` utility
17+
- OpenSSL for testing, and examples
18+
- libcheck for testing
1819

1920
### Build Instructions
2021

22+
```sh
23+
sudo apt install libssl-dev check
24+
```
25+
2126
To build the shared library and example application, run:
2227

2328
```sh
@@ -51,10 +56,10 @@ Include the header in your application:
5156
#include "sigv4.h"
5257
```
5358

54-
Link against the shared library and OpenSSL:
59+
Link against the shared library and your selected crypto backend:
5560

5661
```
57-
-L. -lsigv4 $(pkg-config --libs libssl)
62+
-L. -lsigv4 [crypto backend linkage]
5863
```
5964

6065
### Example

0 commit comments

Comments
 (0)