aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDonald Stufft <donald@stufft.io>2013-08-07 13:01:25 -0700
committerDonald Stufft <donald@stufft.io>2013-08-07 13:01:25 -0700
commit8a7b25670e77e887dff47ab683e49c16e161e80e (patch)
tree17b2d72104aee87f0eb7d5d6c3bd9d37f7353a9a
parent39ffd9095a2735665e2bf1c62799849c7ac5a1bc (diff)
parent9e3c250f66a6cd381972338bcf257f347580481e (diff)
downloadcryptography-8a7b25670e77e887dff47ab683e49c16e161e80e.tar.gz
cryptography-8a7b25670e77e887dff47ab683e49c16e161e80e.tar.bz2
cryptography-8a7b25670e77e887dff47ab683e49c16e161e80e.zip
Merge pull request #11 from alex/more-docs
More docs
-rw-r--r--docs/architecture.rst18
-rw-r--r--docs/index.rst15
2 files changed, 30 insertions, 3 deletions
diff --git a/docs/architecture.rst b/docs/architecture.rst
new file mode 100644
index 00000000..7b394950
--- /dev/null
+++ b/docs/architecture.rst
@@ -0,0 +1,18 @@
+Architecture
+============
+
+.. warning::
+
+ Because ``cryptography`` is so young, much of this document is
+ aspirational, rather than documentation.
+
+``cryptography`` has three different layers:
+
+* ``cryptography.c``: This package contains bindings to low level cryptographic
+ libraries. Our initial target will be OpenSSL.
+* ``cryptography.primitives``: This packages contains low level algorithms,
+ things like ``AES`` or ``SHA1``. This is implemented on top of
+ ``cryptography.c``.
+* ``cryptography``: This package contains higher level recipes, for example
+ "encrypt and then MAC". This is implemented on top of
+ ``cryptography.primitives``.
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