summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorSybren A. St?vel <sybren@stuvel.eu>2011-08-01 20:53:51 +0200
committerSybren A. St?vel <sybren@stuvel.eu>2011-08-01 20:53:51 +0200
commit32a90db15f702f6ad1282f018f12f9ecaac025e4 (patch)
treeabe3be1cecad4e87489a6fddad3fb5592558f44f /README.rst
parente4a6315ccf86519f5e4d5547373d398b392c9d3c (diff)
downloadrsa-32a90db15f702f6ad1282f018f12f9ecaac025e4.tar.gz
Updated readme
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst18
1 files changed, 11 insertions, 7 deletions
diff --git a/README.rst b/README.rst
index 19e27b8..0c24fb4 100644
--- a/README.rst
+++ b/README.rst
@@ -1,19 +1,23 @@
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.
+Python-RSA is a pure-Python RSA implementation. It supports encryption
+and decryption, signing and verifying signatures, and key generation
+according to PKCS#1 version 1.5. It can be used as a Python library as
+well as on the commandline.
-Download and install using:
+Download and install using::
pip install rsa
+or::
+
+ easy_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`_
+The source code is maintained in a `Mercurial repository`_ and is
+licensed under the `Apache License, version 2.0`_
.. _`Mercurial repository`: https://bitbucket.org/sybren/python-rsa