tUpdate README to be cleaner and simpler - sick - sign and check files using ed25519
(HTM) git clone git://z3bra.org/sick
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
(DIR) commit 8e5d85ec0f5d9eb7e8eab583a92b4d8c830330e7
(DIR) parent 1b59e739f7fd450e578e5be3b47370d975333ae2
(HTM) Author: Willy Goiffon <dev@z3bra.org>
Date: Fri, 29 May 2020 19:42:07 +0200
Update README to be cleaner and simpler
Diffstat:
M README | 34 ++++++++++++++++---------------
1 file changed, 18 insertions(+), 16 deletions(-)
---
(DIR) diff --git a/README b/README
t@@ -1,21 +1,16 @@
sick
====
+Cryptographically sign and check files.
-Sign and check streams cryptographically using the ed25519 algorithm.
-
-The sick(1) utility signs and checks streams of data using ed25519
+This utility signs and checks streams of data using ed25519
signatures, either in binary or armored text format.
-Installation
-------------
-This program uses Orson Peters's ed25519 library, with Rob Deker's patch
-to be sodium/SUPERCOP compatible. A working copy is shipped for easier
-integration.
-
-Edit the `config.mk` file to match your setup, then run the following:
-
- $ make
- # make install
+Features
+-----
+- Sign streams of data
+- Made to use with pipes
+- Generate either armored or binary signatures
+- Can use keys from keyring (`$KEYRING` directory)
Usage
-----
t@@ -31,6 +26,13 @@ a quick introduction:
# get the base64 encoded signature of a file
sick -saf alice.key README | tail -c 156
-License
--------
-ISC License. See LICENSE file for copyright and license details.
+Installation
+------------
+Edit config.mk if needed, then build with the following command:
+
+ make install
+
+Require [ed25519][0]. A working copy is shipped for easier integration.
+
+[0]: https://github.com/rdeker/ed25519
+