cryptutils

meta: Add trustworthiness warning to README

Diffstat

1 files changed, 21 insertions, 8 deletions

diff --git a/README.md b/README.md
index 00ba130..bfc5644 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
-# OMKOV cryptutils
+# cryptutils
 
-> OMKOV implementations of cryptographic software utilities
+A collection of cryptographic utilities.
 
-OMKOV cryptutils implements many cryptographic utilities.
+At present, none of these utilities should be trusted entirely.
 
 ## Utilities
 
@@ -10,20 +10,29 @@ OMKOV cryptutils implements many cryptographic utilities.
 | ---------------- | ---------------------------------------- | -------- |
 | alder32          | Compute the Alder-32 for a file          |          |
 | crc32            | Compute the CRC-32 for a file            |          |
+| fnv1a64          | Compute the FNV1a-64 for a file          |          |
 | otp              | Compute HOTP or TOTP tokens              |          |
+| rc2!             | Encrypt and decrypt files using RC2      |          |
 
-## Build Instructions
+- Utilities marked with an asterisk ('*') may be incomplete or non-compliant.
+- Utilities marked with an exclamation mark ('!') require additional caution.
 
-OMKOV cryptutils uses CMake to build.  
-Binaries will be located in the `bin` directory.
+## Usage
 
-### UNIX Build
+**cryptutils** is being developed on x86-64 Linux, and is untested elsewhere.
 
-Run `BuildUNIX.sh`, or
+### Dependencies
 
-```sh
-cmake -S . -B build && cmake --build build
-```
+- CMake >= 3.12, to build
+
+### Building
+
+To build **cryptutils** on on UNIX, run `BuildUNIX.sh`.
+
+### Running
+
+For information on each utility see its respective manpage or use the `--help`
+option.
 
 ## Meta