README in rack-linkeddata-1.0.0 vs README in rack-linkeddata-1.1.0
- old
+ new
@@ -1,24 +1,24 @@
-Linked Data Content Negotiation for Rack Applications
-=====================================================
+# Linked Data Content Negotiation for Rack Applications
This is [Rack][] middleware that provides [Linked Data][] content
negotiation for Rack applications. You can use `Rack::LinkedData` with any
Ruby web framework based on Rack, including with Ruby on Rails 3.0 and with
Sinatra.
* <http://github.com/datagraph/rack-linkeddata>
-Features
---------
+[](http://badge.fury.io/rb/rack-linkeddata)
+[](http://travis-ci.org/ruby-rdf/rack-linkeddata)
+## Features
+
* Implements [HTTP content negotiation][conneg] for RDF content types.
* Supports all [RDF.rb][]-compatible serialization formats.
* Compatible with any Rack application and any Rack-based framework.
-Examples
---------
+## Examples
### Adding Linked Data content negotiation to a Rails 3.x application
# config/application.rb
require 'rack/linkeddata'
@@ -73,12 +73,11 @@
$ curl -iH "Accept: application/rdf+xml" http://localhost:9292/hello
$ curl -iH "Accept: application/json" http://localhost:9292/hello
$ curl -iH "Accept: application/trix" http://localhost:9292/hello
$ curl -iH "Accept: */*" http://localhost:9292/hello
-Description
------------
+## Description
`Rack::LinkedData` implements content negotiation for any [Rack][] response
object that implements the `RDF::Enumerable` mixin. You would typically
return an instance of `RDF::Graph` or `RDF::Repository` from your Rack
application, and let the `Rack::LinkedData::ContentNegotiation` middleware
@@ -88,64 +87,76 @@
The middleware queries [RDF.rb][] for the MIME content types of known RDF
serialization formats, so it will work with whatever serialization plugins
that are currently available for RDF.rb. (At present, this includes support
for N-Triples, N-Quads, Turtle, RDF/XML, RDF/JSON, JSON-LD, RDFa, TriG and TriX.)
-Documentation
--------------
+##Documentation
-<http://datagraph.rubyforge.org/rack-linkeddata/>
+<http://http://rubydoc.info/github/ruby-rdf/rack-linkeddata/>
* {Rack::LinkedData}
* {Rack::LinkedData::ContentNegotiation}
-Dependencies
-------------
+## Dependencies
-* [Rack](http://rubygems.org/gems/rack) (>= 1.4.4)
-* [Linked Data](http://rubygems.org/gems/linkeddata) (>= 1.0)
+* [Rack](http://rubygems.org/gems/rack) (>= 1.5.2)
+* [Linked Data](http://rubygems.org/gems/linkeddata) (>= 1.1)
-Installation
-------------
+## Installation
The recommended installation method is via [RubyGems](http://rubygems.org/).
To install the latest official release of the gem, do:
% [sudo] gem install rack-linkeddata
-Download
---------
+## Download
To get a local working copy of the development repository, do:
% git clone git://github.com/ruby-rdf/rack-linkeddata.git
Alternatively, download the latest development version as a tarball as
follows:
% wget http://github.com/ruby-rdf/rack-linkeddata/tarball/master
-References
-----------
+## Contributing
+This repository uses [Git Flow](https://github.com/nvie/gitflow) to mange development and release activity. All submissions _must_ be on a feature branch based on the _develop_ branch to ease staging and integration.
+* Do your best to adhere to the existing coding conventions and idioms.
+* Don't use hard tabs, and don't leave trailing whitespace on any line.
+* Do document every method you add using [YARD][] annotations. Read the
+ [tutorial][YARD-GS] or just look at the existing code for examples.
+* Don't touch the `.gemspec`, `VERSION` or `AUTHORS` files. If you need to
+ change them, do so on your private branch only.
+* Do feel free to add yourself to the `CREDITS` file and the corresponding
+ list in the the `README`. Alphabetical order applies.
+* Do note that in order for us to merge any non-trivial changes (as a rule
+ of thumb, additions larger than about 15 lines of code), we need an
+ explicit [public domain dedication][PDD] on record from you.
+
+## References
+
* <http://www.w3.org/DesignIssues/LinkedData.html>
* <http://linkeddata.org/docs/how-to-publish>
* <http://linkeddata.org/conneg-303-redirect-code-samples>
* <http://www.w3.org/TR/cooluris/>
* <http://www.w3.org/TR/swbp-vocab-pub/>
* <http://patterns.dataincubator.org/book/publishing-patterns.html>
-Authors
--------
+## Authors
* [Arto Bendiken](http://github.com/bendiken) - <http://ar.to/>
+* [Gregg Kellogg](http://github.com/gkellogg) - <http://greggkellogg.net/>
-License
--------
+## License
This is free and unencumbered public domain software. For more information,
see <http://unlicense.org/> or the accompanying {file:UNLICENSE} file.
[Rack]: http://rack.github.com/
[RDF.rb]: http://ruby-rdf.github.com/rdf/
[Linked Data]: http://linkeddata.org/
[conneg]: http://en.wikipedia.org/wiki/Content_negotiation
+[YARD]: http://yardoc.org/
+[YARD-GS]: http://rubydoc.info/docs/yard/file/docs/GettingStarted.md
+[PDD]: http://unlicense.org/#unlicensing-contributions