/github-api-client forked from farnoy/github-api-client

v2+v3 GitHub API Ruby client library - Moved to farnoy/github-api-client!
Find file
Pull request Compare This branch is 83 commits behind farnoy:master.
Latest commit 51ec2f6 Jan 17, 2012 @farnoy farnoy documentation fixes 
* ported readme to markdown
* changed copyright year to 2012
Permalink
Failed to load latest commit information.
bin api-browser.rb uses local development library for execution. Implemented Jan 7, 2011
db/migrate api-browser.rb uses local development library for execution. Implemented Jan 7, 2011
features Clean up all models in cucumber tests. Jan 7, 2011
lib Fixed Jun 3, 2011
spec Fixed Jun 3, 2011
.gitignore Gemfile.lock with updated dependencies Dec 4, 2010
.rspec Use colored RSpec. Dec 22, 2010
Gemfile fall back to using cucumber, add newest sqlite3 adapter Jan 16, 2012
Gemfile.lock fall back to using cucumber, add newest sqlite3 adapter Jan 16, 2012
LICENSE.txt documentation fixes Jan 16, 2012
README.md documentation fixes Jan 16, 2012
Rakefile fall back to using cucumber, add newest sqlite3 adapter Jan 16, 2012
VERSION Bump to 0.3.0, now with v3 ready api. May 7, 2011
gemspec.old.orig We'll be using jeweler from now. Dec 22, 2010
github-api-client.gemspec Bump to 0.3.0, now with v3 ready api. May 7, 2011

README.md

github-api-client

GitHub API Client that supports caching content client-side, allowing every later requests to be instant.

Configuration

You have three ways of defining your user to have authenticated access to your API:

  1. Put a file in: ~/.github/secrets.yml or \Users\username.github\secrets.yml # secrets.yml user: login: your_login token: your_token
  2. Put GITHUB_USER and GITHUB_TOKEN in your environment, so github-api-client can read it.
  3. Configure your global git profile as defined here https://help.github.com/git-email-settings

Contributing to github-api-client

  • 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
  • Start a feature/bugfix branch
  • Commit and push until you are happy with your contribution
  • 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 (c) 2012 Jakub OkoĊ„ski. See LICENSE.txt for further details.