commit 100f4ff91b5a5b31a84b3999365c3058df6251ea
parent 02b66ec38b474445d10a5d1f0114bc0e8326707e
Author: Brad Conte <brad@bradconte.com>
Date: Thu, 13 Sep 2012 02:25:31 -0500
Added a basic README description.
Diffstat:
1 file changed, 15 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -1,4 +1,17 @@
crypto-algorithms
=================
-Basic implementations of standadr cryptography algorithms, like AES and SHA-1.
-\ No newline at end of file
+
+About
+---
+These are basic implementations of standard cryptography algorithms, written by Brad Conte (brad@bradconte.com) from scratch and without any cross-licensing. They exist to provide publically accessible, restriction-free implementations of popular cryptographic algorithms, like AES and SHA-1. These are primarily intended for educational and pragmatic purposes (such as comparing a specification to actual implementation code, or for building an internal application that computes test vectors for a product). The algorithms have been tested against standard test vectors.
+
+This code is released into the public domain free of any restrictions. The author requests acknowledgement if the code is used, but does not require it. This code is provided free of any liability and without any quality claims by the author.
+
+Note that these are *not* cryptographically secure implementations. They have no resistence to side-channel attacks and should not be used in contexts that need cryptographically secure implementations.
+
+These algorithms are not optimized for speed or space. They are primarily designed to be easy to read, although some basic optimization techniques have been employed.
+
+Building
+---
+The source code for each algorithm will come in a pair of a source code file and a header file. There should be no inter-header file dependencies, no additional libraries, no platform-specific header files, or any other complicating matters. Compiling them should be as easy as adding the relevent source code to the project.
+\ No newline at end of file
