Update README.rst

This commit is contained in:
Gavin M. Roy 2016-04-01 13:38:57 -04:00
parent 9c8ce88169
commit aadb8f7a10

View file

@ -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 <https://sprockets-clients-dynamodb.readthedocs.org>`_.
Requirements
------------
- `Tornado <https://tornadoweb.org>`_
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