README.md: update for github

2013-04-22 13:40:27 +02:00 · 2013-04-22 13:40:27 +02:00 · ea984b8e52
parent 10d733940d
commit ea984b8e52
1 changed files with 94 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -2,6 +2,99 @@
 # Codecrypt
 The post-quantum cryptography tool

-I'm going to add some documentation whenever this starts doing something actually useful. -mk
+## Why this?

+Go read http:/pqcrypto.org/
+
+## Quick How-To
+
+Codecrypt uses hash-based signatures (FMTSeq) and McEliece code-based
+encryption (McE-quasidyadic).
+
+Everything is meant to work mostly like GnuPG, but with some good simplicity margin. Let's play with random data!
+
+	ccr -g help
+	ccr -g fmtseq128 --name "John Doe"    # your signature key
+	ccr -g mceqd128 --name "John Doe"     # your encryption key
+
+	ccr -K  #watch the generated keys
+	ccr -k
+
+	ccr -p -a -o my_pubkeys.asc    # and send it to friends
+
+	#see what people sent us
+	ccr -ina < friends_pubkeys.asc
+
+	#import Frank's key and rename it
+	ccr -i -R friends_pubkeys.asc --name "Friendly Frank"
+
+	#send a nice message to Frank (you can also specify him by @12345 keyid)
+	ccr -se -r Frank < Document.doc > Message_to_frank.ccr
+
+	#receive a reply
+	ccr -dv -o Decrypted_verified_reply.doc <Reply_from_frank.ccr
+
+	#rename other's keys
+	ccr -m Frank -N "Unfriendly Frank"
+
+	#and delete pukeys of everyone who's Unfriendly
+	ccr -x Unfri
+
+## Option reference
+
+For completeness I add listing of all options here (also available at ccr --help)
+
+	Copyright (C) 2013 Mirek Kratochvil <exa.exa@gmail.com>
+	This is free software; see the source for copying conditions.  There is NO
+	warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+	Usage: ./ccr [options]
+
+	Common options:
+	 -h, --help     display this help
+	 -V, --version  display version information
+	 -T, --test     perform (probably nonexistent) testing/debugging stuff
+
+	Global options:
+	 -R, --in      input file, default is stdin
+	 -o, --out     output file, default is stdout
+	 -a, --armor   use ascii-armored I/O
+	 -y, --yes     assume that answer is `yes' everytime
+
+	Actions:
+	 -s, --sign     sign a message
+	 -v, --verify   verify a signed message
+	 -e, --encrypt  encrypt a message
+	 -d, --decrypt  decrypt an encrypted message
+
+	Action options:
+	 -r, --recipient    encrypt for given user
+	 -u, --user         use specified secret key
+	 -C, --clearsign    work with cleartext signatures
+	 -b, --detach-sign  specify file with detached signature
+
+	Key management:
+	 -g, --gen-key        generate specified keypair, `help' lists algorithms
+	 -k, --list           list matching keys
+	 -K, --list-secret
+	 -i, --import         import keys (optionally rename them)
+	 -I, --import-secret
+	 -p, --export         export matching keys
+	 -P, --export-secret
+	 -x, --delete         delete matching keys
+	 -X, --delete-secret
+	 -m, --rename         rename matching keys
+	 -M, --rename-secret
+
+	Key management options:
+	 -n, --no-action    on import, only show what would be imported
+	 -N, --name         specify a new name for renaming or importing
+	 -F, --filter       only work with keys with matching names
+	 -f, --fingerprint  format key IDs nicely for human eyes
+
+## Disclaimer
+
+Codecrypt eats data. Use it with caution.
+
+Author is a self-taught cryptographer.