Permalink
Browse files

Added a few examples

  • Loading branch information...
1 parent 0b5276f commit ceb16f6e77d90fa6cf0d0943831cfb5e30ca7f0f @jstewart committed Jan 19, 2012
Showing with 25 additions and 8 deletions.
  1. +25 −8 README.rdoc → README.md
@@ -1,11 +1,29 @@
-= jiralicious
+# jiralicious
-Description goes here.
+## Examples:
-TODO: Add something useful here.
+Before doing anything, you must configure your session:
+
+ Jiralicious.configure do |config|
+ # Leave out username and password
+ config.username = "youruser"
+ config.password = "yourpass"
+ config.uri = "http://example.com/foo/bar"
+ config.api_version = "latest"
+ end
+
+Search for issues:
+
+ result = Jiralicious.search("key = HSP-1") # Any jql can be used here
+ result.issues
+
+Finding a single issue:
+
+ issue = Jiralicious::Issue.find("HSP-1")
+ issue.key => "HSP-1"
+
+## Contributing to jiralicious
-== Contributing to jiralicious
-
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
* Fork the project
@@ -14,8 +32,7 @@ TODO: Add something useful here.
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-== Copyright
+## Copyright
-Copyright (c) 2010 Jason Stewart. See LICENSE for
+Copyright (c) 2012 Jason Stewart. See LICENSE for
further details.
-

0 comments on commit ceb16f6

Please sign in to comment.