From 49b4f536dc2b73256f522f813058e8d2db3d98a5 Mon Sep 17 00:00:00 2001 From: Erik Michaels-Ober Date: Fri, 2 Dec 2011 12:35:54 -0800 Subject: [PATCH] Update --- README.md | 101 +++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 88 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index a67fdd4..b7a6b4b 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,99 @@ # gemcutter -This is now the `gemcutter` gem only, that provides `gem yank` and `gem webhook`. The Rails app has moved to rubygems/rubygems.org, so please update your links/remotes! +This repository now contains only the `gemcutter` gem, which provides `gem +yank` and `gem webhook`. The Rails app has moved to +[rubygems/rubygems.org][rubygems]. Please update your links and remotes! -## Setup/testing +[rubygems]: https://github.com/rubygems/rubygems.org -Run: +## Installation + gem install gemcutter -``` -bundle -bundle exec rake -``` +## Build Status +[![Build Status](https://secure.travis-ci.org/rubygems/gemcutter.png)][ci] -And your tests should run! +[ci]: http://travis-ci.org/rubygems/gemcutter -## Contributions +## Dependency Status +[![Dependency Status](https://gemnasium.com/rubygems/gemcutter.png)][gemnasium] -Gemcutter has a 'commit-bit' policy, much like the Rubinius project. Submit a patch that is accepted, and you can get full commit access to the project. All you have to do is ask us on #gemcutter on Freenode or bug qrush in a message and he'll add you as a collaborator on the main repository. Feel free to fork the project though and have fun in your own sandbox. +[gemnasium]: https://gemnasium.com/rubygems/gemcutter -Please read up on the [GitHub Wiki](http://wiki.github.com/rubygems/gemcutter/contribution-guidelines) for the latest contribution guidelines. +## Contributing +In the spirit of [free software][free-sw], **everyone** is encouraged to help improve +this project. -## License +[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html -Gemcutter uses the MIT license. Please check the LICENSE file for more details. +Here are some ways *you* can contribute: + +* by using alpha, beta, and prerelease versions +* by reporting bugs +* by suggesting new features +* by writing or editing documentation +* by writing specifications +* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace) +* by refactoring code +* by closing [issues][] +* by reviewing patches + +[issues]: https://github.com/rubygems/gemcutter/issues + +## Submitting an Issue +We use the [GitHub issue tracker][issues] to track bugs and features. Before +submitting a bug report or feature request, check to make sure it hasn't +already been submitted. You can indicate support for an existing issue by +voting it up. When submitting a bug report, please include a [gist][] that +includes a stack trace and any details that may be necessary to reproduce the +bug, including your gem version, Ruby version, and operating system. Ideally, a +bug report should include a pull request with failing specs. + +[gist]: https://gist.github.com/ + +## Submitting a Pull Request +1. Fork the project. +2. Create a topic branch. +3. Implement your feature or bug fix. +4. Add tests for your feature or bug fix. +5. Run `bundle exec rake test`. If your changes are not 100% covered, go back + to step 4. +6. Commit and push your changes. +7. Submit a pull request. Please do not include changes to the gemspec or + version. (If you want to create your own version for some reason, please do + so in a separate commit.) + +## Supported Ruby Versions +This library aims to support and is [tested against][ci] the following Ruby +implementations: + +* Ruby 1.8.7 +* Ruby 1.9.2 +* Ruby 1.9.3 +* [JRuby][] +* [Rubinius][] +* [Ruby Enterprise Edition][ree] + +[jruby]: http://www.jruby.org/ +[rubinius]: http://rubini.us/ +[ree]: http://www.rubyenterpriseedition.com/ + +If something doesn't work on one of these interpreters, it should be considered +a bug. + +This library may inadvertently work (or seem to work) on other Ruby +implementations, however support will only be provided for the versions listed +above. + +If you would like this library to support another Ruby version, you may +volunteer to be a maintainer. Being a maintainer entails making sure all tests +run and pass on that implementation. When something breaks on your +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. + +## License + +Gemcutter is released under the MIT license. Please check the [LICENSE][] file +for more details. + +[license]: https://github.com/rubygems/gemcutter/blob/master/MIT-LICENSE