README.md in open311-0.2.1 vs README.md in open311-0.2.2

- old
+ new

@@ -1,27 +1,21 @@ -Open311 -======= +# Open311 A Ruby wrapper for the Open311 API v2. -Does your project or organization use this gem? ------------------------------------------- +## <a name="apps">Does your project or organization use this gem?</a> Add it to the [apps](https://github.com/codeforamerica/open311/wiki/apps) wiki! -Installation ------------- +## <a name="installation">Installation</a> gem install open311 -Documentation -------------- +## <a name="documentation">Documentation</a> [http://rdoc.info/gems/open311](http://rdoc.info/gems/open311) -Continuous Integration ----------------------- +## <a name="ci">Continuous Integration</a> [![Build Status](https://secure.travis-ci.org/codeforamerica/open311.png)](http://travis-ci.org/codeforamerica/open311) -Usage Examples --------------- +## <a name="examples">Usage Examples</a> require 'open311' # Certain methods require an API key Open311.configure do |config| config.endpoint = 'https://open311.sfgov.org/dev/v2/' @@ -56,12 +50,11 @@ Open311.service_requests({"start_date" => (Time.now - 86400).xmlschema, "end_date" => Time.now.xmlschema}) // last 24 hours # Get multiple service requests by ids, comma separated Open311.service_requests({"service_request_id" => "101000119824,101000119823"}) -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 @@ -72,40 +65,39 @@ * by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace) * by refactoring code * by resolving [issues](https://github.com/codeforamerica/open311/issues) * by reviewing patches -Submitting an Issue -------------------- +## <a name="issues">Submitting an Issue</a> We use the [GitHub issue tracker](https://github.com/codeforamerica/open311/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/codeforamerica/open311) the following Ruby implementations: * Ruby 1.8.7 * Ruby 1.9.2 -* Ruby Enterprise Edition 1.8.7 +* [JRuby](http://www.jruby.org/) +* [Rubinius](http://rubini.us/) +* [Ruby Enterprise Edition](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 @@ -117,11 +109,10 @@ 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) 2010 Code for America. See [LICENSE](https://github.com/codeforamerica/open311/blob/master/LICENSE.md) for details. [![Code for America Tracker](http://stats.codeforamerica.org/codeforamerica/open311.png)](http://stats.codeforamerica.org/projects/open311)