From bf15e17fe7ff9ce48e140c21b328b6cb90d5f45e Mon Sep 17 00:00:00 2001 From: nervuri Date: Fri, 19 Mar 2021 19:19:12 +0000 Subject: [PATCH] update README --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5b1b308..1b2616b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,17 @@ # NetSigil -Sign an entire [Website]/[Gemini capsule]/[Gopher hole] - -Verify any file on a signed [Website]/[Gemini capsule]/[Gopher hole] \ No newline at end of file +* Sign an entire [Website]/[Gemini capsule]/[Gopher hole] +* Verify any file on a signed [Website]/[Gemini capsule]/[Gopher hole] + +Uses [signify](https://www.openbsd.org/papers/bsdcan-signify.html). GPG support might be added later. + +Generates `.well-known/signature-bundle`, a signed tar.gz file. + +Explained here: https://lists.orbitalfox.eu/archives/gemini/2021/005585.html + +Usage: + +``` +netsigil --sign # Sign a local copy of your site +netsigil --verify # Verify remote signature +```