1 files changed, 36 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..256ba78
--- /dev/null
+++ b/README
@@ -0,0 +1,36 @@
+Multihash
+=========
+
+Multihash is a library for hashing with multiple algorithms at the same time.
+The purpose is to enable users to calculate multiple checksums as easy as a
+single checksum, without unnecessary overhead.
+
+Available algorithms:
+
+ * CRC32 (crc32)
+ * Ed2k  (ed2k)
+ * MD5   (md5)
+ * SHA1  (sha1)
+
+Installation
+============
+
+For manual installation; run:
+
+  ./setup.py build
+  sudo ./setup.py install
+
+Usage
+=====
+
+>>> import multihash
+>>> c = multihash.CRC32()
+>>> c.update('foo')
+>>> c.digest()
+'8c736521'
+>>> m = multihash.Multihash('md5', 'sha1')
+>>> m.update('foo')
+>>> m.md5()
+'acbd18db4cc2f85cedef654fccc4a4d8'
+>>> m.sha1()
+'0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33'