README sync and minor updates.

- Sync README between Digital Bazaar JSON-LD libs.
- Minor updates and formatting fixes.
This commit is contained in:
David I. Lehn 2014-12-05 16:45:41 -05:00
parent 2314cfe0d1
commit 0b0442696d

View file

@ -8,27 +8,26 @@ php-json-ld
Introduction
------------
JSON, as specified in RFC4627, is a simple language for representing
This library is an implementation of the [JSON-LD][] specification in [PHP][].
JSON, as specified in [RFC7159][], is a simple language for representing
objects on the Web. Linked Data is a way of describing content across
different documents or Web sites. Web resources are described using
IRIs, and typically are dereferencable entities that may be used to find
more information, creating a "Web of Knowledge". JSON-LD is intended to
be a simple publishing method for expressing not only Linked Data in
more information, creating a "Web of Knowledge". [JSON-LD][] is intended
to be a simple publishing method for expressing not only Linked Data in
JSON, but for adding semantics to existing JSON.
This library is an implementation of the [JSON-LD] specification
in [PHP].
JSON-LD is designed as a light-weight syntax that can be used to express
Linked Data. It is primarily intended to be a way to express Linked Data
in Javascript and other Web-based programming environments. It is also
in JavaScript and other Web-based programming environments. It is also
useful when building interoperable Web Services and when storing Linked
Data in JSON-based document storage engines. It is practical and
designed to be as simple as possible, utilizing the large number of JSON
parsers and existing code that is in use today. It is designed to be
able to express key-value pairs, RDF data, RDFa [RDFA-CORE] data,
Microformats [MICROFORMATS] data, and Microdata [MICRODATA]. That is, it
supports every major Web-based structured data model in use today.
able to express key-value pairs, RDF data, [RDFa][] data,
[Microformats][] data, and [Microdata][]. That is, it supports every
major Web-based structured data model in use today.
The syntax does not require many applications to change their JSON, but
easily add meaning by adding context in a way that is either in-band or
@ -105,7 +104,7 @@ Commercial Support
------------------
Commercial support for this library is available upon request from
Digital Bazaar: support@digitalbazaar.com
[Digital Bazaar][]: support@digitalbazaar.com
Source
------
@ -115,11 +114,14 @@ is available at:
http://github.com/digitalbazaar/php-json-ld
Tests
-----
This library includes a sample testing utility which may be used to verify
that changes to the processor maintain the correct output.
To run the sample tests you will need to get the test suite files by cloning
the [json-ld.org repository][json-ld.org] hosted on GitHub.
the [json-ld.org repository][json-ld.org] hosted on GitHub:
https://github.com/json-ld/json-ld.org
@ -128,7 +130,11 @@ containing the tests.
phpunit test.php -d {PATH_TO_JSON_LD_ORG/test-suite}
[PHP]: http://php.net
[Digital Bazaar]: http://digitalbazaar.com/
[JSON-LD]: http://json-ld.org/
[Microdata]: http://www.w3.org/TR/microdata/
[Microformats]: http://microformats.org/
[PHP]: http://php.net
[RDFa]: http://www.w3.org/TR/rdfa-core/
[RFC7159]: http://tools.ietf.org/html/rfc7159
[json-ld.org]: https://github.com/json-ld/json-ld.org