aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2013-12-15 23:09:13 -0800
committerAlex Gaynor <alex.gaynor@gmail.com>2013-12-15 23:09:13 -0800
commit5175e4e6394ade40e38dc00b8e1e14a2877aafe4 (patch)
treece9073684c790f908044f939e92312ad82112514 /docs/index.rst
parent973499aded3ce3580a8c6d44aa111288240f90a1 (diff)
parentffb7726fa3042e66e8011fbd17a8b6f83f0c8110 (diff)
downloadcryptography-5175e4e6394ade40e38dc00b8e1e14a2877aafe4.tar.gz
cryptography-5175e4e6394ade40e38dc00b8e1e14a2877aafe4.tar.bz2
cryptography-5175e4e6394ade40e38dc00b8e1e14a2877aafe4.zip
Merge branch 'master' into validate-iv
Conflicts: cryptography/hazmat/primitives/ciphers/modes.py tests/hazmat/primitives/test_block.py
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst23
1 files changed, 16 insertions, 7 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 1b88e24e..776c9d37 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.
@@ -44,4 +53,4 @@ Hazardous Materials
:maxdepth: 2
hazmat/primitives/index
- hazmat/bindings/index
+ hazmat/backends/index