aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2013-12-12 18:03:26 -0800
committerAlex Gaynor <alex.gaynor@gmail.com>2013-12-12 18:03:26 -0800
commit31df5357132319de7c9eb7154dd72ddebcbc4afa (patch)
tree66f4d420b574357c8e928a6832f6dc7e638a3df0
parent29b4a936821393a185b14d717c4241c2e415277f (diff)
downloadcryptography-31df5357132319de7c9eb7154dd72ddebcbc4afa.tar.gz
cryptography-31df5357132319de7c9eb7154dd72ddebcbc4afa.tar.bz2
cryptography-31df5357132319de7c9eb7154dd72ddebcbc4afa.zip
More info in teh index
-rw-r--r--docs/index.rst19
1 files changed, 16 insertions, 3 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 1b88e24e..a1a650a8 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -6,13 +6,26 @@ Welcome to ``cryptography``
``cryptography`` is very young, and very incomplete.
``cryptography`` is a Python library which exposes cryptographic recipes and
-primitives.
+primitives. We hope it'll be your one-stop-shop for all your cryptographic
+needs in Python.
+
+Installing
+----------
+
+We don't yet have a release on PyPI, for now you can install ``cryptography``
+directly from Github:
+
+.. code-block:: console
+
+ $ pip install git+https://github.com/pyca/cryptography
Why a new crypto library for Python?
------------------------------------
-We wanted to address a few issues with existing cryptography libraries in
-Python:
+If you've done cryptographic work in Python before, you've probably seen some
+other libraries in Python, such as *M2Crypto*, *PyCrypto*, or *PyOpenSSL*. In
+building ``cryptography`` we wanted to address a few issues we observed in the
+existing libraries:
* Lack of PyPy and Python 3 support.
* Lack of maintenance.