aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2013-12-14 08:33:54 -0800
committerAlex Gaynor <alex.gaynor@gmail.com>2013-12-14 08:33:54 -0800
commit4b0f9ab4e733f7183fc0f67acbc251b5d9a56758 (patch)
treead18caf3b26bd57a7cadfbdba4e5edd97d3c49f8 /docs/index.rst
parent554df80072ede5e154020af39ce0c664de0582b5 (diff)
parentca4a22b4dea8243d02bc4a2699048694e591ae75 (diff)
downloadcryptography-4b0f9ab4e733f7183fc0f67acbc251b5d9a56758.tar.gz
cryptography-4b0f9ab4e733f7183fc0f67acbc251b5d9a56758.tar.bz2
cryptography-4b0f9ab4e733f7183fc0f67acbc251b5d9a56758.zip
Merge branch 'master' into fernet
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst21
1 files changed, 15 insertions, 6 deletions
diff --git a/docs/index.rst b/docs/index.rst
index b9bf1735..0b023276 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,18 +1,27 @@
Welcome to ``cryptography``
===========================
-.. warning::
+``cryptography`` is a Python library which exposes cryptographic recipes and
+primitives. We hope it'll be your one-stop-shop for all your cryptographic
+needs in Python.
- ``cryptography`` is very young, and very incomplete.
+Installing
+----------
-``cryptography`` is a Python library which exposes cryptographic recipes and
-primitives.
+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.