Permalink
Browse files

Added some documentation

  • Loading branch information...
1 parent 81571b1 commit 25dced35b687f9abbc68d6c9a78ac672de329e5c @edavis10 committed Apr 10, 2010
Showing with 8 additions and 2 deletions.
  1. +8 −2 README.rdoc
View
@@ -1,6 +1,12 @@
-= redmine_client
+= Redmine API Client
-Description goes here.
+Rubygem to access the Redmine API. Based on the documentation from http://www.redmine.org/wiki/redmine/Rest_api_with_ruby
+
+== Usage
+
+*This gem and the Redmine API is under development and subject to change at any notice.*
+
+There is an example script in bin/test.rb showing the basic usage.
== Note on Patches/Pull Requests

0 comments on commit 25dced3

Please sign in to comment.