aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorskeuomorf <skeuomorf@gmail.com>2014-01-29 21:41:02 +0200
committerskeuomorf <skeuomorf@gmail.com>2014-01-29 21:43:02 +0200
commitb0293bf7ed069fc1469d098cc71b9c50b9080d25 (patch)
treef89c1b3d1f31514ee5c195c678896ce70a9a3e33 /docs/index.rst
parentbc26efb3668a3f66fd13a6a8d3ef72f91e11af8e (diff)
downloadcryptography-b0293bf7ed069fc1469d098cc71b9c50b9080d25.tar.gz
cryptography-b0293bf7ed069fc1469d098cc71b9c50b9080d25.tar.bz2
cryptography-b0293bf7ed069fc1469d098cc71b9c50b9080d25.zip
Added installation section to index.rst
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst18
1 files changed, 11 insertions, 7 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 73c40bf0..93b25ecf 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -5,6 +5,16 @@ Welcome to ``cryptography``
primitives. We hope it'll be your one-stop-shop for all your cryptographic
needs in Python.
+Installation
+------------
+You can install ``cryptography`` with ``pip``:
+
+.. code-block:: console
+
+ $ pip install cryptography
+
+see :doc:`Installation<installation>` for more information
+
Why a new crypto library for Python?
------------------------------------
@@ -40,13 +50,6 @@ admonition at the top.
We recommend using the recipes layer whenever possible, and falling back to the
hazmat layer only when necessary.
-Installation
-~~~~~~~~~~~~
-.. toctree::
- :maxdepth: 2
-
- installation
-
The recipes layer
~~~~~~~~~~~~~~~~~
@@ -73,6 +76,7 @@ The ``cryptography`` open source project
.. toctree::
:maxdepth: 2
+ installation
contributing
security
api-stability