aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2013-08-07 12:59:04 -0700
committerAlex Gaynor <alex.gaynor@gmail.com>2013-08-07 12:59:04 -0700
commit1abfac7909df31a5eabe29e9dfd23db55d867834 (patch)
treee4c69c26b832cbf62fb3acd7c70cdfa2d7aefa06 /docs/index.rst
parent39ffd9095a2735665e2bf1c62799849c7ac5a1bc (diff)
downloadcryptography-1abfac7909df31a5eabe29e9dfd23db55d867834.tar.gz
cryptography-1abfac7909df31a5eabe29e9dfd23db55d867834.tar.bz2
cryptography-1abfac7909df31a5eabe29e9dfd23db55d867834.zip
Start to document the architecture.
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst15
1 files changed, 12 insertions, 3 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 47acbde9..9001d668 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,7 +1,16 @@
-Welcome to ``cryptography``'s documentation!
-============================================
+Welcome to ``cryptography``
+===========================
+
+.. warning::
+
+ ``cryptography`` is very young, and very incomplete.
+
+``cryptography`` is a Python library which exposes cryptographic primitives and
+recipes.
Contents:
.. toctree::
- :maxdepth: 2
+ :maxdepth: 2
+
+ architecture