Initial identicons-web releaseHEADmain

1 files changed, 26 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1470ba7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# identicons-web
+
+VFace identity generator and verifier for the Virebent web service.
+
+The project contains:
+
+- `index.php`, the PHP verifier and identity page generator;
+- `identicons-cli.go`, a dependency-free Go CLI implementing the
+  Ch1ffr3punk identicon rendering used by VFace and Aegis.
+
+## Build the CLI
+
+```sh
+go build -buildvcs=false -o identicons-cli .
+```
+
+The PHP application expects the compiled `identicons-cli` beside `index.php`
+and requires PHP sodium support. Deploy the directory behind a PHP-capable web
+server. Do not make uploaded files executable or writable by the web process.
+
+## VFace input
+
+The deterministic identity input is `username|email|canonical-ed25519-public-key`.
+The service publishes verification data and PNG hashes, but private keys must
+remain on the user's device and must never be uploaded or committed.
+