README.md in gems-0.4.0 vs README.md in gems-0.5.0
- old
+ new
@@ -1,23 +1,18 @@
-Gems
-====
+# Gems
Ruby wrapper for the RubyGems.org API.
-Installation
-------------
+## <a name="installation">Installation</a>
gem install gems
-Documentation
--------------
+## <a name="documentation">Documentation</a>
[http://rdoc.info/gems/gems](http://rdoc.info/gems/gems)
-Continuous Integration
-----------------------
+## <a name="ci">Continuous Integration</a>
[](http://travis-ci.org/rubygems/gems)
-Usage Examples
---------------
+## <a name="examples">Usage Examples</a>
require 'rubygems'
require 'gems'
# Returns some basic information about rails.
puts Gems.info 'rails'
@@ -90,12 +85,11 @@
# Update a previously yanked gem back into RubyGems.org's index.
# Defaults to the latest version if no version is specified.
Gems.unyank 'bills', '0.0.1'
-Contributing
-------------
+## <a name="contributing">Contributing</a>
In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
Here are some ways *you* can contribute:
* by using alpha, beta, and prerelease versions
@@ -106,33 +100,30 @@
* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
* by refactoring code
* by closing [issues](https://github.com/rubygems/gems/issues)
* by reviewing patches
-Submitting an Issue
--------------------
+## <a name="issues">Submitting an Issue</a>
We use the [GitHub issue tracker](https://github.com/rubygems/gems/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 issuse by voting it up. When submitting a
bug report, please include a [Gist](https://gist.github.com/) 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.
-Submitting a Pull Request
--------------------------
+## <a name="pulls">Submitting a Pull Request</a>
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 <tt>bundle exec rake doc:yard</tt>. If your changes are not 100% documented, go back to step 4.
6. Add specs for your feature or bug fix.
7. Run <tt>bundle exec rake spec</tt>. 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 gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
-Supported Rubies
-----------------
+## <a name="rubies">Supported Rubies</a>
This library aims to support and is [tested
against](http://travis-ci.org/rubygems/gems) the following Ruby
implementations:
* Ruby 1.9.1
@@ -150,9 +141,8 @@
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.
-Copyright
----------
+## <a name="copyright">Copyright</a>
Copyright (c) 2011 Erik Michaels-Ober.
See [LICENSE](https://github.com/rubygems/gems/blob/master/LICENSE.md) for details.