Update README.md

Author: noinoiexists

README.md

@@ -1,17 +1,25 @@
 # Bit Flip Cipher
 
-Bit Flip Cipher is a simple encryption tool that encrypts text using a key-derived SHA-256 hash with XOR bit flipping. Since this is a symmetric cipher, decryption is performed using the same key that was used for encryption.
+Bit Flip Cipher is a simple encryption tool that encrypts text using a key-derived SHA-256 hash with XOR bit flipping and gives a Base64 output. Since this is a symmetric cipher, decryption is performed using the same key that was used for encryption.
 This tool was created as a fun project for me to learn more about C and Linux.
 
-**Version**: 1.0.0
+**Latest Version**: 1.1.0
 
-## How the Cipher Works
+## How the Cipher Works  
 
-1. The user provides a key (password) for encryption/decryption.
+### Encryption
+1. The user provides a key (password) and the text to be encrypted.
 2. A SHA-256 hash of the key is generated.
 3. Each byte of the input text is XOR-ed with the corresponding byte from the hash (looping through the hash as needed).
-4. The resulting text is the output.
-5. Applying the process again with the same key will decrypt the text.
+4. The resultant is encoded to Base64 to ensure that it is printable.
+5. The Base64 ciphertext is the output.
+
+### Decryption
+1. The user provides a key (password) and the Base64 encoded text obtained from encryption.
+2. The Base64 text is decoded back to the original XOR-ed encrypted form.
+3. A SHA-256 hash of the key is generated.
+4. Each byte of the encrypted text is XOR-ed with the corresponding byte from the hash (looping through the hash as needed). This produces the original text, as this process is symmetric.
+5. The resultant plaintext is the output
 
 ## Installation
 
@@ -21,26 +29,22 @@ As of now, a package file is available only for Debian-based distros (Debian, Ub
 
 - Download the latest `.deb` package by running this command:
   ```sh
-  wget https://github.com/noinoiexists/Bit-Flip-Cipher/releases/download/bflip-v1.0.0/bflip_1.0.0_amd64.deb
+  wget https://github.com/noinoiexists/Bit-Flip-Cipher/releases/download/bflip-v1.1.0/bflip_1.1.0_amd64.deb
   ```
 - Install it using your package manager (`apt`):
    ```sh
-   sudo apt install ./bflip_1.0.0_amd64.deb
+   sudo apt install ./bflip_1.1.0_amd64.deb && rm ./bflip_1.1.0_amd64.deb
    ```
 The tool is now installed and can be run as `bflip`.   
 
 ### Method 2: Compile from Source
 
-**Requirements**:  `gcc`,  `make`,  `libssl-dev`
+**Requirements**:  `gcc`,  `make`, `git`, `libssl-dev`
 - Install the required tools and libraries using your package manager.
-- Download the latest source code archive by running this command:
-  ```sh
-  wget https://github.com/noinoiexists/Bit-Flip-Cipher/archive/refs/tags/bflip-v1.0.0.tar.gz
-  ```
-- Extract, compile and install the code:
+- Clone this repository, compile and install the code:
   ```sh
-  tar -xvzf ./bflip-v1.0.0.tar.gz
-  cd Bit-Flip-Cipher-bflip-v1.0.0/
+  git clone https://github.com/noinoiexists/Bit-Flip-Cipher.git
+  cd Bit-Flip-Cipher/
   make
   sudo make install
   ```
@@ -52,17 +56,19 @@ This will compile the binary and install it in `/usr/local/bin/`. It can be run
 
 ## Usage
 
-
-`bflip -k <key> [text]`
+Encrypt: `bflip -k <key> [text]`  
+Decrypt: `bflip -d -k <key> [base64_text]`
 
 Examples:  
- `bflip -k secretkey 'hello world'`  
- `bflip -k 'multi-word secretkey' 'hello world'`   
-  `printf 'hello world' | bflip -k secretkey`  
+  `bflip -k secretkey 'hello world'`  
+  `bflip -k 'multi-word secretkey' 'hello world'`   
+  `echo -n 'hello world' | bflip -k secretkey`  
+  `bflip -d -k secretkey 'BASE64_ENCODED_TEXT'`  
 
+Options:  
 ```
-Options:
   -k <key>      Specify the encryption/decryption key (string).
+  -d            Decrypt bflip encrypted text (Base64 string).
   -h, --help    Display the help menu.
   -v, --version Display the version information.
 ```