summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Duncan <pabs@pablotron.org>2023-10-15 01:36:12 -0400
committerPaul Duncan <pabs@pablotron.org>2023-10-15 01:36:12 -0400
commit4d639569410e51f5aaefb6ae3d9282a58a28f562 (patch)
treee32ea2a96446f1e23c30a09213f9fade0ca6ad81
parent53b7de16ebc65d6e49e469a87d3c1357ef3b024b (diff)
downloadsha3-4d639569410e51f5aaefb6ae3d9282a58a28f562.tar.bz2
sha3-4d639569410e51f5aaefb6ae3d9282a58a28f562.zip
README.md: add "Usage" section
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 326a836..ff9241a 100644
--- a/README.md
+++ b/README.md
@@ -168,6 +168,16 @@ int main(void) {
See the `examples/` directory for more examples.
+## Usage
+
+To use this library in your application:
+
+1. Copy `sha3.h` and `sha3.c` into your source tree.
+2. Update your build system to compile `sha3.o`.
+3. Include `sha3.h` in your application.
+
+See examples in the `examples/` directory.
+
## Documentation
Full [API][] documentation is available in the comments of `sha3.h`. If