Steve Losh avatar Steve Losh committed 27f2a5e

Update docs.

Comments (0)

Files changed (1)

 python-dribbble is a simple Python library for interacting with [Dribbble][].
-It's [MIT/X11 licensed][license]. It requires [Python][] 2.5+.
-
-It was written in about half an hour, so don't expect miracles.
+It's [MIT/X11 licensed][license]. It requires [Python][] 2.6+ or 2.5 and
+[simplejson][].
 
 Install it with [pip][]:
 
 * `player`: The Player that made this shot.
 
 
+Contributing
+============
+
+Fork the [Mercurial repository][bb] (preferred) or the [git repository][gh],
+add your feature, send a pull request. Stick to the coding style and add a test
+for your feature.
+
+Make sure you look at the existing tests before writing your own -- they do
+ugly "clever" things to avoid getting banned by Dribbble's API.
+
 [Dribbble]: http://dribbble.com/
 [license]: http://en.wikipedia.org/wiki/MIT_License
 [Python]: http://python.org/
+[simplejson]: http://simplejson.googlecode.com/svn/tags/simplejson-2.1.1/docs/index.html
 [pip]: http://pip.openplans.org/
+[bb]: http://bitbucket.org/sjl/python-dribbble/
+[gh]: http://github.com/sjl/python-dribbble/
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.