Add README

cwc · May 1, 2012 · 3d5f848 · 3d5f848
1 parent b8acc57
commit 3d5f848
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,21 @@
+coderwall
+=========
+A Python module for accessing user data at http://coderwall.com
+
+Usage:
+------
+```
+>>> from coderwall import CoderWall
+>>> cwc = CoderWall('cwc')
+>>> cwc.name
+u'Cameron Currie'
+>>> cwc.location
+u'Austin, TX'
+>>> cwc.endorsements
+0
+>>> cwc.badges
+[Charity: Fork and commit to someone's open source project in need, 
+Python: Would you expect anything less? Have at least one original repo 
+where Python is the dominant language, T-Rex: Have at least one original 
+repo where C is the dominant language]
+```