Skip to content

Commit 0b04426

Browse files
committed
README sync and minor updates.
- Sync README between Digital Bazaar JSON-LD libs. - Minor updates and formatting fixes.
1 parent 2314cfe commit 0b04426

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed

README.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,26 @@ php-json-ld
88
Introduction
99
------------
1010

11-
JSON, as specified in RFC4627, is a simple language for representing
11+
This library is an implementation of the [JSON-LD][] specification in [PHP][].
12+
13+
JSON, as specified in [RFC7159][], is a simple language for representing
1214
objects on the Web. Linked Data is a way of describing content across
1315
different documents or Web sites. Web resources are described using
1416
IRIs, and typically are dereferencable entities that may be used to find
15-
more information, creating a "Web of Knowledge". JSON-LD is intended to
16-
be a simple publishing method for expressing not only Linked Data in
17+
more information, creating a "Web of Knowledge". [JSON-LD][] is intended
18+
to be a simple publishing method for expressing not only Linked Data in
1719
JSON, but for adding semantics to existing JSON.
1820

19-
This library is an implementation of the [JSON-LD] specification
20-
in [PHP].
21-
2221
JSON-LD is designed as a light-weight syntax that can be used to express
2322
Linked Data. It is primarily intended to be a way to express Linked Data
24-
in Javascript and other Web-based programming environments. It is also
23+
in JavaScript and other Web-based programming environments. It is also
2524
useful when building interoperable Web Services and when storing Linked
2625
Data in JSON-based document storage engines. It is practical and
2726
designed to be as simple as possible, utilizing the large number of JSON
2827
parsers and existing code that is in use today. It is designed to be
29-
able to express key-value pairs, RDF data, RDFa [RDFA-CORE] data,
30-
Microformats [MICROFORMATS] data, and Microdata [MICRODATA]. That is, it
31-
supports every major Web-based structured data model in use today.
28+
able to express key-value pairs, RDF data, [RDFa][] data,
29+
[Microformats][] data, and [Microdata][]. That is, it supports every
30+
major Web-based structured data model in use today.
3231

3332
The syntax does not require many applications to change their JSON, but
3433
easily add meaning by adding context in a way that is either in-band or
@@ -105,7 +104,7 @@ Commercial Support
105104
------------------
106105

107106
Commercial support for this library is available upon request from
108-
Digital Bazaar: [email protected]
107+
[Digital Bazaar][]: [email protected]
109108

110109
Source
111110
------
@@ -115,11 +114,14 @@ is available at:
115114

116115
http://github.com/digitalbazaar/php-json-ld
117116

117+
Tests
118+
-----
119+
118120
This library includes a sample testing utility which may be used to verify
119121
that changes to the processor maintain the correct output.
120122

121123
To run the sample tests you will need to get the test suite files by cloning
122-
the [json-ld.org repository][json-ld.org] hosted on GitHub.
124+
the [json-ld.org repository][json-ld.org] hosted on GitHub:
123125

124126
https://github.com/json-ld/json-ld.org
125127

@@ -128,7 +130,11 @@ containing the tests.
128130

129131
phpunit test.php -d {PATH_TO_JSON_LD_ORG/test-suite}
130132

131-
[PHP]: http://php.net
133+
[Digital Bazaar]: http://digitalbazaar.com/
132134
[JSON-LD]: http://json-ld.org/
135+
[Microdata]: http://www.w3.org/TR/microdata/
136+
[Microformats]: http://microformats.org/
137+
[PHP]: http://php.net
138+
[RDFa]: http://www.w3.org/TR/rdfa-core/
139+
[RFC7159]: http://tools.ietf.org/html/rfc7159
133140
[json-ld.org]: https://github.com/json-ld/json-ld.org
134-

0 commit comments

Comments
 (0)