summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md41
1 files changed, 40 insertions, 1 deletions
diff --git a/README.md b/README.md
index 418aec4..841ad3c 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,40 @@
-Workbluhp in blogress!!
+Onetimebluh (Workbluhp in blogress!!)
+======================================
+
+Simple implementation of One Time Pad cipher.
+Capable of generating cryptographically strong random number keys and of usign them to encrypt/decrypt messages of same length with a bitwise XOR function.
+
+Usage
+-------
+
+Example creates two keys of lenght 4096 bytes and use the first as a message and the second as the pad key (just for testing):
+
+'''
+onetimebluh --key-gen --nbytes 4096 --output message
+onetimebluh --key-gen --nbytes 4096 --output pad
+onetimebluh --encrypt message --key-file key --output encrypted-message
+onetimebluh --decrypt encrypted-message --key-file key --outptut decrypted-message
+'''
+
+You can print the help by running 'onetimebluh --help' or 'onetimebluh -h'.
+
+'''
+ONETIMEBLUH USAGE:;
+onetimebluh [COMMAND] [OPTIONS] ...
+
+COMMANDS:
+
+-d, --decrypt=FILE decrypt message (input) same ad --encrypt, just for the feeling
+-e, --encrypt=FILE encrypt message (input)
+-h, --help print this help
+-g, --key-gen create key file
+
+OPTIONS
+
+-k, --key-file=FILE use key (input)
+-b, --nbytes=NUM number of bytes
+-o, --output=FILE output name
+
+Onetimebluh project repository at http://git.eigenlab.org/Seppia/onetimebluh
+
+'''