From 872cd9791f344147764e47625faaaefeeceab3dd Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Mon, 10 Feb 2014 18:52:47 -0800 Subject: Fixed #576 -- improve the readme --- README.rst | 20 ++++++++++++++++---- docs/index.rst | 3 +-- 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 0c59136e..c85ae95f 100644 --- a/README.rst +++ b/README.rst @@ -9,13 +9,25 @@ Cryptography ``cryptography`` is a package designed to expose cryptographic recipes and -primitives to Python developers. +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. -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. +``cryptography`` includes both high level recipes, and low level algorithms. +For example, to encrypt something with ``cryptography``: -You can find more information in the `documentation`_. +.. code-block:: python + + >>> 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 ------------ -- cgit v1.2.3 From 9993699223651ba6a227133a82b656bf415bf84d Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Tue, 11 Feb 2014 14:10:37 -0800 Subject: Fixed the language decl for htis block --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index c85ae95f..708df21e 100644 --- a/README.rst +++ b/README.rst @@ -15,7 +15,7 @@ standard library". It supports Python 2.6-2.7, Python 3.2+, and PyPy. ``cryptography`` includes both high level recipes, and low level algorithms. For example, to encrypt something with ``cryptography``: -.. code-block:: python +.. code-block:: pycon >>> from cryptography.fernet import Fernet >>> # Put this somewhere safe! -- cgit v1.2.3 From c0469911d3b93f18b474caac0f533c25596e40d1 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Tue, 11 Feb 2014 14:21:46 -0800 Subject: Phrase more precisely --- README.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 708df21e..b7d60cbd 100644 --- a/README.rst +++ b/README.rst @@ -12,8 +12,10 @@ Cryptography 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 algorithms. -For example, to encrypt something with ``cryptography``: +``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 -- cgit v1.2.3