aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Reid <dreid@dreid.org>2014-02-11 14:23:26 -0800
committerDavid Reid <dreid@dreid.org>2014-02-11 14:23:26 -0800
commite202a049ff6e3bcd5ba3b3c95356b57982ffaa42 (patch)
tree437b7506e56b82c5a8e55910c4c4b6cc56bc5a28
parentecfcf0f46af3d9f13406ec277d8dd078a59d8d8b (diff)
parentc0469911d3b93f18b474caac0f533c25596e40d1 (diff)
downloadcryptography-e202a049ff6e3bcd5ba3b3c95356b57982ffaa42.tar.gz
cryptography-e202a049ff6e3bcd5ba3b3c95356b57982ffaa42.tar.bz2
cryptography-e202a049ff6e3bcd5ba3b3c95356b57982ffaa42.zip
Merge pull request #593 from alex/better-readme
Fixed #576 -- improve the readme
-rw-r--r--README.rst24
-rw-r--r--docs/index.rst3
2 files changed, 20 insertions, 7 deletions
diff --git a/README.rst b/README.rst
index 0c59136e..b7d60cbd 100644
--- a/README.rst
+++ b/README.rst
@@ -9,14 +9,28 @@ Cryptography
``cryptography`` is a package designed to expose cryptographic recipes and
-primitives to Python developers.
-
-It is currently in early development and isn't recommended for general usage
-yet. It targets Python 2.6-2.7, Python 3.2+, and PyPy.
+primitives to Python developers. Our goal is for it to be your "cryptographic
+standard library". It supports Python 2.6-2.7, Python 3.2+, and PyPy.
+
+``cryptography`` includes both high level recipes, and low level interfaces to
+common cryptographic algorithms such as symmetric ciphers, message digests and
+key derivation functions. For example, to encrypt something with
+``cryptography``'s high level symmetric encryption recipe:
+
+.. code-block:: pycon
+
+ >>> from cryptography.fernet import Fernet
+ >>> # Put this somewhere safe!
+ >>> key = Fernet.generate_key()
+ >>> f = Fernet(key)
+ >>> token = f.encrypt(b"A really secret message. Not for prying eyes.")
+ >>> token
+ '...'
+ >>> f.decrypt(token)
+ 'A really secret message. Not for prying eyes.'
You can find more information in the `documentation`_.
-
Discussion
~~~~~~~~~~
diff --git a/docs/index.rst b/docs/index.rst
index 9114b895..19feb603 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -2,8 +2,7 @@ Welcome to ``cryptography``
===========================
``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.
+primitives. Our goal is for it to be your "cryptographic standard library".
Installation
------------