From fb926c1980c426fbc1d0a08bdee894f630f79bf7 Mon Sep 17 00:00:00 2001 From: David Fischer <djfische@gmail.com> Date: Sun, 10 Mar 2013 20:20:18 -0700 Subject: [PATCH] Filled out the readme --- README.rst | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.rst b/README.rst index f40dd022..bd42d02c 100644 --- a/README.rst +++ b/README.rst @@ -3,3 +3,34 @@ PyNaCl .. image:: https://travis-ci.org/dstufft/pynacl.png?branch=master :target: https://travis-ci.org/dstufft/pynacl + +PyNaCl is a Python binding to the `Networking and Cryptography library`_, +a crypto library with the stated goal of improving usability, security and +speed. + +.. _Networking and Cryptography library: http://nacl.cr.yp.to/ + + +Installation +------------ + +PyNaCl relies on libsodium_, a portable C library which can be compiled +on a variety of systems. It may already be available from your package +manager. + +.. _libsodium: https://github.com/jedisct1/libsodium + +Once libsodium is installed, PyNaCl can be installed by: + +.. code-block:: bash + + $ python setup.py install + + +Features +-------- + +* Digital signatures +* Secret-key encryption +* Public-key encryption (coming soon) +* HMAC (coming soon) -- GitLab