From 291dfb08a77addd39e40c6a0dae69d398a628886 Mon Sep 17 00:00:00 2001
From: ENGO150 <v.smejkal06@gmail.com>
Date: Wed, 9 Mar 2022 19:11:08 +0100
Subject: [PATCH] created basic read-me

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0c3a3d0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# WHY2 Encryption System
+
+*Yeah.*
+
+This project is made 'like a library', so compiling is useless... :)
+
+### Table of contents
+
+  - [Using in Your projects](#using-in-your-projects)
+  - [Example of code](#example-of-code)
+  - [Example programs](#example-programs)
+
+## Using in Your projects 
+
+To **encrypt** text, use function `encryptText()` from file `include/encrypter.h`.
+
+To **decrypt** text, use function `decryptText()` from file `include/decrypter.h`.
+
+Jump to [examples](#examples) if you're not sure, how to use.
+
+## Example of code
+
+- Encryption:
+    ```c
+    //FIRST VARIANT
+    char *yourText = encryptText("Put here text, you want encrypt...", "tzXlZGxkhfYOvRthqokDrmGFyDMylgmeIlrJTpVAwuqrLjABXM"); //The second thing is Your **key**. (The key must be 50 characters long!)
+
+    //SECOND VARIANT
+    char *yourText = encryptText("Put here text, you want encrypt...", NULL); //See? You don't have to use Your key. Program will automatically generate one for you. It will be printed out, so save it somewhere.
+    ```
+
+- Decryption:
+    ```c
+    char *yourText = decryptText("158.-83.9388.-14.57.8419.113.-98.10576", "tzXlZGxkhfYOvRthqokDrmGFyDMylgmeIlrJTpVAwuqrLjABXM"); //First parameter is Your encrypted text, the second is key you want to use for decryption it.
+    ```
+
+## Example programs
+
+Uhm... There aren't any examples (for now)... I will maybe create some... Later...
\ No newline at end of file