Permalink
Browse files

Add dependency status [ci skip]

  • Loading branch information...
1 parent c836bbe commit a1953a83b3c4dadba604803338531b8d04735893 @sferik sferik committed Dec 1, 2011
Showing with 51 additions and 29 deletions.
  1. +51 −29 README.md
View
@@ -1,8 +1,8 @@
# MultiJSON
Lots of Ruby libraries utilize JSON parsing in some form, and everyone has
their favorite JSON library. In order to best support multiple JSON parsers and
-libraries, <tt>multi_json</tt> is a general-purpose swappable JSON backend
-library. You use it like so:
+libraries, `multi_json` is a general-purpose swappable JSON backend library.
+You use it like so:
require 'multi_json'
@@ -15,21 +15,32 @@ library. You use it like so:
MultiJson.encode({ :abc => 'def' }, :pretty => true) # encoded in a pretty form (ignored if engine is ok_json)
-The <tt>engine</tt> setter takes either a symbol or a class (to allow for
-custom JSON parsers) that responds to both <tt>.decode</tt> and
-<tt>.encode</tt> at the class level.
+The `engine` setter takes either a symbol or a class (to allow for custom JSON
+parsers) that responds to both `.decode` and `.encode` at the class level.
MultiJSON tries to have intelligent defaulting. That is, if you have any of the
supported engines already loaded, it will utilize them before attempting to
load any. When loading, libraries are ordered by speed. First Yajl-Ruby, then
the JSON gem, then JSON pure. If no JSON library is available, MultiJSON falls
-back to a bundled version of [OkJson](https://github.com/kr/okjson).
+back to a bundled version of [OkJson][].
+
+[okjson]: https://github.com/kr/okjson
## <a name="ci">Continuous Integration</a>
-[![Build Status](https://secure.travis-ci.org/intridea/multi_json.png)](http://travis-ci.org/intridea/multi_json)
+[![Build Status](https://secure.travis-ci.org/intridea/multi_json.png)][ci]
+
+[ci]: http://travis-ci.org/intridea/multi_json
+
+## <a name="dependencies"></a>Dependency Status
+[![Dependency Status](https://gemnasium.com/intridea/multi_json.png)][gemnasium]
+
+[gemnasium]: https://gemnasium.com/intridea/multi_json
## <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.
+In the spirit of [free software][free-sw], **everyone** is encouraged to help
+improve this project.
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
Here are some ways *you* can contribute:
@@ -38,42 +49,51 @@ Here are some ways *you* can contribute:
* 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 writing code (**no patch is too small**: fix typos, add comments, clean up
+ inconsistent whitespace)
* by refactoring code
-* by closing [issues](https://github.com/intridea/multi_json/issues)
+* by closing [issues][]
* by reviewing patches
+[issues]: https://github.com/intridea/multi_json/issues
+
## <a name="issues">Submitting an Issue</a>
-We use the [GitHub issue
-tracker](https://github.com/intridea/multi_json/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.
+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 issuse 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/
## <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 specs for your feature or bug fix.
-5. Run <tt>bundle exec rake spec</tt>. If your changes are not 100% covered, go back to step 4.
+5. Run `bundle exec rake spec`. 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, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
+7. 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.)
-## <a name="rubies">Supported Rubies</a>
-This library aims to support and is [tested
-against](http://travis-ci.org/intridea/multi_json) the following Ruby
+## <a name="versions">Supported Ruby Versions</a>
+This library aims to support and is [tested against][ci] the following Ruby
implementations:
* Ruby 1.8.7
-* Ruby 1.9.1
* Ruby 1.9.2
-* [JRuby](http://www.jruby.org/)
-* [Rubinius](http://rubini.us/)
-* [Ruby Enterprise Edition](http://www.rubyenterpriseedition.com/)
+* 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.
@@ -91,4 +111,6 @@ time of a major release, support for that Ruby version may be dropped.
## <a name="copyright">Copyright</a>
Copyright (c) 2010 Michael Bleigh, Josh Kalderimis, Erik Michaels-Ober, and Intridea, Inc.
-See [LICENSE](https://github.com/intridea/multi_json/blob/master/LICENSE.md) for details.
+See [LICENSE][] for details.
+
+[license]: https://github.com/intridea/multi_json/blob/master/LICENSE.md

0 comments on commit a1953a8

Please sign in to comment.