Permalink
Browse files

add usage and versions to readme

  • Loading branch information...
1 parent b47d9e7 commit 20afa9cc841f687800b8fb32499c0d4a6223a7a0 @danielhfrank danielhfrank committed Mar 6, 2012
Showing with 39 additions and 4 deletions.
  1. +39 −4 README.md
View
@@ -1,6 +1,41 @@
-asyncdynamo
------------
+Asyncdynamo
+===========
-async Amazon DynamoDB library for Tornado
+Asynchronous Amazon DynamoDB library for Tornado
-requires boto and python 2.7
+Requires boto and python 2.7
+
+Tested with Boto 2.2.1 and Tornado 1.2.1
+
+Installation
+------------
+
+Installing from github: `pip install git+https://github.com/bitly/asyncdynamo.git`
+
+Installing from source: `git clone git://github.com/bitly/asyncdynamo.git; cd asyncdynamo; python setup.py install`
+
+Usage
+-----
+Asyncdynamo syntax seeks to mirror that of [Boto](http://github.com/boto/boto).
+
+```python
+from asyncdynamo import asyncdynamo
+db = asyncdynamo.AsyncDynamoDB("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY")
+
+def item_cb(item):
+ print item
+
+db.get_item('YOUR_TABLE_NAME', 'ITEM_KEY', item_cb)
+```
+
+Requirements
+------------
+The following two python libraries are required
+
+* [boto](http://github.com/boto/boto)
+* [tornado](http://github.com/facebook/tornado)
+
+Issues
+------
+
+Please report any issues via [github issues](https://github.com/bitly/asyncdynamo/issues)

0 comments on commit 20afa9c

Please sign in to comment.