Kalebu
diff --git a/‎README.md
Copy file name to clipboard
+70Lines changed: 70 additions & 0 deletions b/‎README.md
Copy file name to clipboard
+70Lines changed: 70 additions & 0 deletions
diff --git a/‎app.py renamed to ‎algorithms.py
Copy file name to clipboardExpand all lines: algorithms.py
+12Lines changed: 12 additions & 0 deletions b/‎app.py renamed to ‎algorithms.py
Copy file name to clipboardExpand all lines: algorithms.py
+12Lines changed: 12 additions & 0 deletions
@@ -1,2 +1,72 @@
 # ascii-encryption-python
 Beginner guide to ascii based encryption implemented in Python 
+
+Getting started 
+----------------
+This is just a simple encryption algorithms that can be cool when it comes to understanding and exploring how does encryption works, but not seriously used to handle security on real life circumstances 
+
+To get started with repo you might have to clone or download the repository just as shown below;
+
+```bash
+
+git clone https://github.com/Kalebu/ascii-encryption-python
+
+```
+
+Basics
+----------------
+If you're new to ascii encryption, this simple involving converting the alphabetics to their ascii numerical value and using a secret number to add or substract from their real value and then turning back into characters as encrypted one.
+
+For instance 
+
+```bash
+
+Encrypting 
+
+a - > 97 -> 97 (+|-) secret_number -> new characer
+
+Lets say our secret number is 5
+
+a -> 97 -> 97 + 5 -> f
+
+Decrypting 
+
+To descrypt we need to know the secret number otherwise we wont be able to do it so
+
+f -> 102 -> 102 (+|-) secret number -> decrypted character
+
+Since we know the serect number is 5
+
+f -> 102 -> 102 - 5 > a 
+
+```
+
+In this repository I have implemented two simple function just do that, which take a textual input of any size and then encrypt it using ascii value based on your secret number and then it will return back encrypted text.
+
+Samewise to decryption, you are going to specify the secret number and then it will recieve your encrypted text input and then render to you decrypted text output 
+
+
+Demo 
+------------
+
+```python
+>>> from algorithms import encrypt , decrypt
+>>> army_text = "Throw the missiles at 9pm"
+>>> encrypt(army_text, key=10)
+'^r|y\x81*~ro*ws}}svo}*k~*Czw'
+>>> decrypt('^r|y\x81*~ro*ws}}svo}*k~*Czw', key=10)
+'Throw the missiles at 9pm'
+```
+
+Explore it 
+-----------
+Now keep explore it by testing it with various input links to see what links it will scrap 
+
+Give it a star 
+--------------
+Did you find this information useful, then give it a star 
+
+
+Credits
+-----------
+All the credits to [kalebu](github.com/kalebu)
@@ -1,3 +1,9 @@
+# ===============================================================
+# ============ FUNCTION TO DO ASCII BASED ENCRYPTION  ===========
+# ============         BASED ON A CERTAIN KEY         ===========
+# ================================================================
+
+
 def encrypt(text, key=0):
     if not isinstance(text, str):
         raise TypeError("{} should be a type string".format(text))
@@ -6,6 +12,12 @@ def encrypt(text, key=0):
     return "".join([chr(ord(something) + key) for something in text])
 
 
+# ===================================================================
+# ============= FUNCTION TO DO ASCII BASED DECRYPTION ===============
+# =============       BASED ON A CERTAIN KEY          ===============
+# ===================================================================
+
+
 def decrypt(text, key=0):
     if not isinstance(text, str):
         raise TypeError("{} should be a type string".format(text))