commit 0992d0811c957908726ef22cebaebdb045904df0
parent 3d8fc3b3af15af6b043ae8e3ff12fdacf830db2d
Author: finwo <finwo@pm.me>
Date: Tue, 29 Aug 2017 17:37:35 +0200
Made the README a tad more verbose
Diffstat:
1 file changed, 17 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -2,6 +2,22 @@
A self-made cryptography algorithm. This is an example implementation of the scheme idea's promoted [here](https://gist.github.com/finwo/ebfd96e35eeffc19dc25f5afc11b9c98). The algorithm HAS NOT been tested for actual cryptographic strength, do not assume this provides anything more than obfuscation.
----
+## How keys are build
Keys are composed of 2 unsigned 32-bit integers, the multiplicand and the modulator. The only restriction on these numbers is that the modulator must be >=128, which results in ((2^32)-128)*(2^32) = 18446743523953737728 possible keys. Padding is forced to further randomize the output and has no structural restrictions.
+
+## Dependencies
+
+- musl-gcc or gcc
+- libc
+
+## Building
+
+```
+./configure
+make
+```
+
+## Usage
+
+Simple run `./cryptotest` to see the usage or look inside `src/main.c`
