GitHub RubyGems

Welcome to GitHub's RubyGem repository!

Installing a RubyGem from GitHub

There have been issues reported using gem sources -a http://gems.github.com,
so please use the manual source install below until a resolution is found.

  $ sudo gem install username-projectname --source=http://gems.github.com

Example Usage:

  $ sudo gem install mojombo-grit --source=http://gems.github.com
  Successfully installed mojombo-grit-0.8.1
  $ irb -rubygems
  
  (regular require)
  >> require 'grit'
  => true
  
  (explicit require)
  >> gem 'mojombo-grit'
  => true
  >> require 'grit'
  => true  

Hosting a RubyGem on GitHub

If you'd like to host your gem on Github, please do the following:

1. Create a new repository on GitHub if you haven't already.
2. Add project_name.gemspec to the root directory. (example gemspec)
3. Go to your project's edit screen and check the 'RubyGem' box.
4. Push your gemspec to GitHub and we'll build a gem (prefixed with your username) on the fly.
5. Any subsequent changes you make to your gemspec, we'll build a new gem for you.

Troubleshooting

• If your gem isn't showing up, double-check that your 'RubyGem' checkbox is checked on your repo, it's really easy to forget this step.
• Verify your gemspec works prior to pushing by running the following:

  $ gem build project_name.gemspec

• Once you've pushed your gemspec to GitHub, it may take a few minutes for your new gem to find its way into our index.
• We'll build a new version of the gem or rebuild an existing version of the gem based upon the version you set in your gemspec.
• Gems will only be built when the gemspec is modified on the master branch.
• The gemspec is eval'd with $SAFE set to 3, disallowing usage of code like external requires and Dir.glob().
  If your gem builds fine locally, but doesn't on GitHub, that's most likely your problem.
• If you're currently using Hoe to manage your gems, you can run 'rake debug_gem' to generate the gemspec.
• Report any bugs or feature requests to Lighthouse (include your gemspec and please remember to try and build the gem locally first).