|
1 | 1 | # JSON-LD reader/writer |
2 | 2 |
|
3 | | -[JSON-LD][] reader/writer for [RDF.rb][RDF.rb] and fully conforming [JSON-LD][] processor. |
| 3 | +[JSON-LD][] reader/writer for [RDF.rb][RDF.rb] and fully conforming [JSON-LD API][] processor. Additionally this gem implements [JSON-LD Framing][]. |
4 | 4 |
|
5 | 5 | [](http://badge.fury.io/rb/json-ld) |
6 | 6 | [](http://travis-ci.org/ruby-rdf/json-ld) |
@@ -220,13 +220,12 @@ Install with `gem install json-ld` |
220 | 220 | Full documentation available on [RubyDoc](http://rubydoc.info/gems/json-ld/file/README.md) |
221 | 221 |
|
222 | 222 | ## Differences from [JSON-LD API][] |
223 | | -The specified JSON-LD API is based on a WebIDL definition intended for use within the browser. |
| 223 | +The specified JSON-LD API is based on a WebIDL definition implementing [Promises][] intended for use within a browser. |
224 | 224 | This version implements a more Ruby-like variation of this API without the use |
225 | | -of futures and callback arguments, preferring Ruby blocks. All API methods |
226 | | -execute synchronously, so that the return from a method can be used as well as a block. |
| 225 | +of promises or callback arguments, preferring Ruby blocks. All API methods |
| 226 | +execute synchronously, so that the return from a method can typically be used as well as a block. |
227 | 227 |
|
228 | | -Note, the API method signatures differed in versions before 1.0, in that they also had |
229 | | -a callback parameter. |
| 228 | +Note, the API method signatures differed in versions before 1.0, in that they also had a callback parameter. And 1.0.6 has some other minor method signature differences than previous versions. This should be the only exception to the use of semantic versioning. |
230 | 229 |
|
231 | 230 | ### Principal Classes |
232 | 231 | * {JSON::LD} |
@@ -288,5 +287,7 @@ see <http://unlicense.org/> or the accompanying {file:UNLICENSE} file. |
288 | 287 | [PDD]: http://lists.w3.org/Archives/Public/public-rdf-ruby/2010May/0013.html |
289 | 288 | [RDF.rb]: http://rubygems.org/gems/rdf |
290 | 289 | [Backports]: http://rubygems.org/gems/backports |
291 | | -[JSON-LD]: http://json-ld.org/spec/latest/ |
292 | | -[JSON-LD API]: http://json-ld.org/spec/latest/json-ld-api/ |
| 290 | +[JSON-LD]: http://www.w3.org/TR/json-ld/ "JSON-LD 1.0" |
| 291 | +[JSON-LD API]: http://www.w3.org/TR/json-ld-api/ "JSON-LD 1.0 Processing Algorithms and API" |
| 292 | +[JSON-LD Framing]: http://json-ld.org/spec/latest/json-ld-framing/ "JSON-LD Framing 1.0" |
| 293 | +[Promises]: http://dom.spec.whatwg.org/#promises |
0 commit comments