summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorSybren A. St?vel <sybren.stuvel@chess.nl>2011-08-01 11:30:03 +0200
committerSybren A. St?vel <sybren.stuvel@chess.nl>2011-08-01 11:30:03 +0200
commitc6cf4dcd5fd28579e924117e9afbfebf56176ec7 (patch)
treef87769d9b1bc24e610a06fa4a4b877ee42907926 /README.rst
parent40da520765e427d9ffa00b781d07e6c6466e1f56 (diff)
downloadrsa-c6cf4dcd5fd28579e924117e9afbfebf56176ec7.tar.gz
Moved README to README.rst
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..05a510d
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,22 @@
+Pure Python RSA implementation
+==============================
+
+As an assignment for the University of Amsterdam we wrote a pure Python RSA
+implementation. It's a module for calculating large primes, and RSA encryption,
+decryption, signing and verification. It also includes generating public and
+private keys.
+
+Download and install using:
+
+ pip install rsa
+
+or download it from the `Python Package Index`_.
+
+The source code is maintained in a `Mercurial repository`_ and is licensed under
+the `Apache License, version 2.0`_
+
+
+.. _`Mercurial repository`: http://hg.stuvel.eu/python-rsa
+.. _`Python Package Index`: http://pypi.python.org/pypi/rsa
+.. _`Apache License, version 2.0`: http://www.apache.org/licenses/LICENSE-2.0
+