Home.md

@@ -0,0 +1,30 @@
+# Kato's PHP Crypto Wrapper
+## Info
+
+### About
+Hey, thanks for taking a look at my project. My library is a simple wrapper for the openssl_encrypt function, taking care of osme annoying things and havins some checks here and there so that you don't have to.
+If you worry about security, I can reassure you that I have taken upmost care of the securty aspect, as well as the performance, my priorities were in the following order:
+
+1. Security
+2. Validation
+3. Performance
+
+I know, performance is last, but trust me when I do tell you that I do understand that adding more and more steps to processing your data, however optimized they might be, it's a big overhead, with encryption there really isn't much we can do about performance since it's an extremely important step, the thing is, I have added the option to disable checks when encrypting so that if you need to do some things quickly you can and have the option.
+
+### Future
+The future of the project really does depend on what is happening in my life, I do like maintaining this as it's a super small project that I can make as high quality as I can, as well as reliable! Hopefully helping a lot of developers out there with headaches of loosing time to implement an encryption class in their codebase.
+
+## Features
+
+### String Encryption
+The string encryption method takes a whole string to digest and isn't as optimized as the file encryption, this is really only meant for things such as usernames, passwords, etc... Not big strings that take too much memory since the peak_memory_usage will be the same as 2 times the size of said string.
+
+### File Encryption
+
+I have tried my best to optimize for memory usage, using the fstream function I can read chunks of the file and encrypt them straight into memory instead of reading it all in memory only to do the same thing but less efficiently.
+
+## Examples
+
+
+
+