From aadb8f7a10998978ae06b81910fe6e5dd558d183 Mon Sep 17 00:00:00 2001 From: "Gavin M. Roy" Date: Fri, 1 Apr 2016 13:38:57 -0400 Subject: [PATCH] Update README.rst --- README.rst | 51 ++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 48 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index a6d83c9..a0e825d 100644 --- a/README.rst +++ b/README.rst @@ -1,3 +1,48 @@ -Amazon DynamoDB Connector -========================= -Connects an application to an Amazon DynamoDB instance. +DynamoDB Client +=============== +An asynchronous DynamoDB client for Tornado + +|Version| |Downloads| |Status| |Coverage| |License| + +Installation +------------ +``sprockets.clients.dynamodb`` may be installed via the Python package index with the tool of +your choice. I prefer pip: + +.. code:: bash + + pip install sprockets.clients.dynamodb + +Example +------- + +.. code:: python + + + +Documentation +------------- +Documentation is available on `ReadTheDocs `_. + +Requirements +------------ +- `Tornado `_ + +Version History +--------------- +Available at https://sprockets-clients-dynamodb.readthedocs.org/en/latest/history.html + +.. |Version| image:: https://img.shields.io/pypi/v/tornado-dynamodb.svg? + :target: http://badge.fury.io/py/tornado-dynamodb + +.. |Status| image:: https://img.shields.io/travis/sprockets/sprockets.clients.dynamodb.svg? + :target: https://travis-ci.org/sprockets/sprockets.clients.dynamodb + +.. |Coverage| image:: https://img.shields.io/codecov/c/github/sprockets/sprockets.clients.dynamodb.svg? + :target: https://codecov.io/github/sprockets/sprockets.clients.dynamodb?branch=master + +.. |Downloads| image:: https://img.shields.io/pypi/dm/tornado-dynamodb.svg? + :target: https://pypi.python.org/pypi/tornado-dynamodb + +.. |License| image:: https://img.shields.io/pypi/l/tornado-dynamodb.svg? + :target: https://tornado-dynamodb.readthedocs.org