]> Sergey Matveev's repositories - uploader.git/blobdiff - README
Sort tcpserver's options
[uploader.git] / README
diff --git a/README b/README
index b97d1adfc6feaca7e545b7784e9b7898e8c913ad..4f2abcba60381b68b0c92b2cfba300426a469233 100644 (file)
--- a/README
+++ b/README
@@ -1,3 +1,23 @@
-Simplest form file uploader.
+Simplest HTTP form file uploader.
+
 It just saves uploaded file from HTML form to the new file on the disk.
-Also it calculates BLAKE2s checksum, replying with it in the answer.
+Also it calculates BLAKE2b-512 checksum, replying with it in the answer.
+
+You can upload files with curl:
+
+    curl -F file=@somedata.tar.gpg \
+        [ -F comment="optional comment" ] \
+        http://localhost:8086/upload/
+
+and verify integrity locally:
+
+    b2sum somedata.tar.gpg
+
+You can enable mail notification with -notify-to and -notify-from options.
+It is advisable to run it under daemontools-like supervisor
+(http://cr.yp.to/daemontools.html). Example service/uploader provided.
+
+You can also run it as UCSPI-TCP service (https://cr.yp.to/ucspi-tcp.html),
+like in service/uploader example.
+
+uploader is free software: see the file COPYING for copying conditions.