diff options
author | Alex Gaynor <alex.gaynor@gmail.com> | 2014-02-10 18:52:47 -0800 |
---|---|---|
committer | Alex Gaynor <alex.gaynor@gmail.com> | 2014-02-10 18:52:47 -0800 |
commit | 872cd9791f344147764e47625faaaefeeceab3dd (patch) | |
tree | c3d65b42d86b17fb7ee369deb8ec1b8a68b708af | |
parent | bc1f8b887e0f9d362f6f6148b72ccdcf92f8e341 (diff) | |
download | cryptography-872cd9791f344147764e47625faaaefeeceab3dd.tar.gz cryptography-872cd9791f344147764e47625faaaefeeceab3dd.tar.bz2 cryptography-872cd9791f344147764e47625faaaefeeceab3dd.zip |
Fixed #576 -- improve the readme
-rw-r--r-- | README.rst | 20 | ||||
-rw-r--r-- | docs/index.rst | 3 |
2 files changed, 17 insertions, 6 deletions
@@ -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 ------------ |