Readme and license

readme.md

@@ -0,0 +1,57 @@
+# Ghettocrypt
+*because frankly i have no idea what the fuck i'm doing*  
+<sub>*Please don't use this for anything critical*</sub>
+
+## What the hell is this?
+An educational project on implementing a block cipher using a feistel network.  
+To provide at least some security this is using some DES-inspired tactics like *cipher block chaining* and *output feedback modus*.
+This way this provides relatively good diffusion.
+
+## Features
+* It has a very easy syntax
+* It's slow
+* It's probably super insecure
+* It leaves your keys sprinkled in ram
+* But the syntax is pythonlike easy🙇
+It's pretty ghetto, you know?
+
+## What are the actual advantages?
+* It's two files to import into the project
+* 1 Line to use
+* 100% cross plattform
+
+## When could i use it?
+* For data obfuscation
+* If your only other option would be no encryption at all
+
+### I am not kidding, don't use this for critical stuff! Homebrew ciphers are most often shit!
+Especially mine!🦯
+
+## LICENSE
+```
+BSD 2-Clause License
+
+Copyright (c) 2021, Leon Etienne
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```