From d1020a1e490df1c2f5e5647ab8e7cacd316ed300 Mon Sep 17 00:00:00 2001
From: Seppia <seppia@seppia.net>
Date: Sun, 28 Jan 2018 14:30:18 +0100
Subject: Updated README.md

Updates and fixes programs informations and adds install instructions.
---
 README.md | 51 ++++++++++++++++++++++++++++++++-------------------
 1 file changed, 32 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index d1ee599..29f6658 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,31 @@
-# Onetimebluh (Workbluhp in blogress!!)
+# Onetimebluh
 
 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.
 
 ## Build
 
-To build onetimebluh just run `make` or `make all`, and You will find the executable binary in the build folder. If you want to install it, just run `make install` and `make clean` to get rid of all the compiled files.
+To build onetimebluh just run `make` and You will find the executable binary in the build folder.
+
+## Install
+
+If you want to install onetimebluh, just run `make install`.
+If you are using Archlinux onetimebluh is available in the [AUR](https://aur.archlinux.org/packages/otbluh-git/) and in my unofficial Archlinux repository [Seppianet](https://archlinux/seppia.net/).
+
+To use the repo simply add the following to you `pacman.conf` (currently the repo has only `x86_64` packages):
+
+```
+[seppianet]
+SigLevel = Optional
+Server = https://archlinux.seppia.net/$arch
+```
 
 ## Usage
 
-Example creates two keys of length 4096 bytes and use the first as a message and the second as the pad key (just for testing):
+This example creates a `message` file of 4096 and a key of the same length (we are encrypting a pseudo random bytes file):
 
 ```
-otbluh --key-gen --nbytes 4096 --output message
+dd bs=512 count=8 if=/dev/urandom of=message
 otbluh --key-gen --nbytes 4096 --output pad
 otbluh --encrypt message --key-file pad --output encrypted-message
 otbluh --decrypt encrypted-message --key-file pad --outptut decrypted-message
@@ -35,28 +48,28 @@ If you want you can use the `--bluh` function to get the binary dump of yuor enc
 otbluh --bluh message --output bluhed-message
 ```
 
-You can print the help by running `onetimebluh --help` or `onetimebluh -h`.
+You can print the help by running `onetimebluh --help`.
 
 ```
-ONETIMEBLUH USAGE:
+Onetimebluh usage:
 otbluh [COMMAND] [OPTIONS]
 
-COMMANDS:
+Commands:
 
--b, --bluh=FILE            bluhes your message or in other words performs a binary dump
--d, --decrypt=FILE         decrypt message (input) same ad --encrypt, just for the feeling
--e, --encrypt=FILE         encrypt message (input)
--g, --gen-key              create key file
--h, --help                 print this help
--u, --unbluh=FILE          unbluhes your message (gets the orginal message from the binary dump)
+ -b, --bluh=FILE            bluhes your message or in other words performs a binary dump
+ -d, --decrypt=FILE         decrypt message (input) same ad --encrypt, just for the feeling
+ -e, --encrypt=FILE         encrypt message (input)
+ -g, --gen-key              create key file
+ -h, --help                 print this help
+ -u, --unbluh=FILE          unbluhes your message (gets the orginal message from the binary dump)
 
-OPTIONS
+Options:
 
--c, --char=CAHRS           reads two cahracters as argument and uses them to bluh your message
--k, --key-file=KEY_FILE    use key (input)
--n, --nbytes=NUM           number of bytes
--o, --output=FILE          output name
--t, --tear-page            deletes from the pad file the bytes used to encrypt/decrypt
+ -c, --char=CAHRS           reads two cahracters as argument and uses them to bluh your message
+ -k, --key-file=KEY_FILE    use key (input)
+ -n, --nbytes=NUM           number of bytes
+ -o, --output=FILE          output name
+ -t, --tear-page            deletes from the pad file the bytes used to encrypt/decrypt
 
 Onetimebluh project repository at https://git.eigenlab.org/seppia/onetimebluh
 ```
-- 
cgit v1.2.3