diff --git a/README.md b/README.md index 8947a6997..3d21ec53a 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,15 @@ Simple Ruby wrapper for the GitHub v2 & v3 API. [travis]: http://travis-ci.org/pengwynn/octokit [gemnasium]: https://gemnasium.com/pengwynn/octokit -## Installation +## Installation gem install octokit -## Documentation +## Documentation [http://rdoc.info/gems/octokit][documentation] [documentation]: http://rdoc.info/gems/octokit -## Examples +## Examples ### Show a user ```ruby Octokit.user("sferik") @@ -26,7 +26,7 @@ Octokit.following("sferik") ``` ### Repositories -For convenience, methods that require a repoistory argument may be passed in any of the following forms: +For convenience, methods that require a repository argument may be passed in any of the following forms: * `"pengwynn/octokit"` * `{:username => "pengwynn", :name => "octokit"}` @@ -38,7 +38,7 @@ Octokit.repo("pengwynn/octokit") => <#Hashie::Rash created_at="2009/12/10 13:41:49 -0800" description="Simple Ruby wrapper for the GitHub v2 API and feeds" fork=false forks=25 has_downloads=true has_issues=true has_wiki=true homepage="http://wynnnetherland.com/projects/octokit" integrate_branch="master" language="Ruby" name="octokit" open_issues=8 owner="pengwynn" private=false pushed_at="2011/05/05 10:48:57 -0700" size=1804 url="https://github.com/pengwynn/octokit" watchers=92> ``` -## Authenticated Requests +## Authenticated Requests For methods that require authentication, you'll need to setup a client with your login and password. @@ -56,22 +56,26 @@ client = Octokit::Client.new(:login => "me", :oauth_token => "oauth2token") client.follow!("sferik") ``` -## Submitting a Pull Request -1. Fork the project. -2. Create a topic branch. -3. Implement your feature or bug fix. -4. Add documentation for your feature or bug fix. -5. Run `bundle exec rake doc:yard`. If your changes are not 100% documented, go - back to step 4. -6. Add specs for your feature or bug fix. -7. Run `bundle exec rake spec`. If your changes are not 100% covered, go back - to step 6. -8. Commit and push your changes. -9. Submit a pull request. Please do not include changes to the version or - gemspec. (If you want to create your own version for some reason, please do - so in a separate commit.) - -## Supported Ruby Versions +## Submitting a Pull Request +1. [Fork the repository.][fork] +2. [Create a topic branch.][branch] +3. Add specs for your unimplemented feature or bug fix. +4. Run `bundle exec rake spec`. If your specs pass, return to step 3. +5. Implement your feature or bug fix. +6. Run `bundle exec rake spec`. If your specs fail, return to step 5. +7. Run `open coverage/index.html`. If your changes are not completely covered + by your tests, return to step 3. +8. Add documentation for your feature or bug fix. +9. Run `bundle exec rake doc:yard`. If your changes are not 100% documented, go + back to step 8. +10. Add, commit, and push your changes. +11. [Submit a pull request.][pr] + +[fork]: http://help.github.com/fork-a-repo/ +[branch]: http://learn.github.com/p/branching.html +[pr]: http://help.github.com/send-pull-requests/ + +## Supported Ruby Versions This library aims to support and is [tested against][travis] the following Ruby implementations: @@ -98,13 +102,13 @@ implementation, you will be personally responsible for providing patches in a timely fashion. If critical issues for a particular implementation exist at the time of a major release, support for that Ruby version may be dropped. -## Inspiration +## Inspiration Octokit was inspired by [Octopi][] and aims to be a lightweight, less-ActiveResourcey alternative. [octopi]: https://github.com/fcoury/octopi -## Copyright +## Copyright Copyright (c) 2011 Wynn Netherland, Adam Stacoviak, Erik Michaels-Ober. See [LICENSE][] for details. diff --git a/Rakefile b/Rakefile old mode 100755 new mode 100644 index 21c058c55..baef3fa20 --- a/Rakefile +++ b/Rakefile @@ -1,5 +1,3 @@ -#!/usr/bin/env rake - require 'bundler' Bundler::GemHelper.install_tasks