Skip to content

Commit fe6f0b7

Browse files
author
Andrew Stewart Gibson
committed
lines broken into 80 characters or less (except where for code samples or URLs)
1 parent 405d0d6 commit fe6f0b7

File tree

1 file changed

+46
-15
lines changed

1 file changed

+46
-15
lines changed

‎README.md‎

Lines changed: 46 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,33 +7,58 @@
77
## Introduction
88
This library is an implementation of the JSON-LD specification in C#.
99

10-
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 JSON, but for adding semantics to existing JSON.
11-
12-
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 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 data, Microformats data, and Microdata. That is, it supports every major Web-based structured data model in use today.
13-
14-
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 out-of-band. The syntax is designed to not disturb already deployed systems running on JSON, but provide a smooth migration path from plain JSON to semantically enhanced JSON. Finally, the format is intended to be fast to parse, fast to generate, stream-based and document-based processing compatible, and require a very small memory footprint in order to operate.
10+
JSON, as specified in RFC7159, is a simple language for representing objects on
11+
the Web. Linked Data is a way of describing content across different documents
12+
or Web sites. Web resources are described using IRIs, and typically are
13+
dereferencable entities that may be used to find more information, creating a
14+
"Web of Knowledge". JSON-LD is intended to be a simple publishing method for
15+
expressing not only Linked Data in JSON, but for adding semantics to existing
16+
JSON.
17+
18+
JSON-LD is designed as a light-weight syntax that can be used to express Linked
19+
Data. It is primarily intended to be a way to express Linked Data in JavaScript
20+
and other Web-based programming environments. It is also useful when building
21+
interoperable Web Services and when storing Linked Data in JSON-based document
22+
storage engines. It is practical and designed to be as simple as possible,
23+
utilizing the large number of JSON parsers and existing code that is in use
24+
today. It is designed to be able to express key-value pairs, RDF data, RDFa
25+
data, Microformats data, and Microdata. That is, it supports every major
26+
Web-based structured data model in use today.
27+
28+
The syntax does not require many applications to change their JSON, but easily
29+
add meaning by adding context in a way that is either in-band or out-of-band.
30+
The syntax is designed to not disturb already deployed systems running on JSON,
31+
but provide a smooth migration path from plain JSON to semantically enhanced
32+
JSON. Finally, the format is intended to be fast to parse, fast to generate,
33+
stream-based and document-based processing compatible, and require a very small
34+
memory footprint in order to operate.
1535

1636
You can read more about JSON-LD on the [JSON-LD website][jsonld].
1737

1838
## Conformance
1939

2040
This library aims to conform with the following:
2141

22-
* [JSON-LD 1.0][JSON-LD 1.0], W3C Recommendation, 2014-01-16, and any [errata][errata]
23-
* [JSON-LD 1.0 Processing Algorithms and API][JSON-LD 1.0 API], W3C Recommendation, 2014-01-16, and any [errata][errata]
42+
* [JSON-LD 1.0][JSON-LD 1.0], W3C Recommendation, 2014-01-16, and any
43+
[errata][errata]
44+
* [JSON-LD 1.0 Processing Algorithms and API][JSON-LD 1.0 API], W3C
45+
Recommendation, 2014-01-16, and any [errata][errata]
2446
* [JSON-LD 1.0 Framing][JSON-LD 1.0 Framing], Unofficial Draft, 2012-08-30
2547
* Working Group [test suite][WG test suite]
2648

2749
The [JSON-LD Working Group][JSON-LD WG] is now developing JSON-LD 1.1. Library
2850
updates to conform with newer specifications will happen as features stabilize
2951
and development time and resources permit.
3052

31-
* [JSON-LD 1.1][JSON-LD WG 1.1], W3C Working Draft, 2018-12-14 or [newer][JSON-LD WG latest]
32-
* [JSON-LD 1.1 Processing Algorithms and API][JSON-LD WG 1.1 API], W3C Working Draft, 2018-12-14 or [newer][JSON-LD WG API latest]
33-
* [JSON-LD 1.1 Framing][JSON-LD WG 1.1 Framing], W3C Working Draft, 2018-12-14 or [newer][JSON-LD WG Framing latest]
53+
* [JSON-LD 1.1][JSON-LD WG 1.1], W3C Working Draft, 2018-12-14 or
54+
[newer][JSON-LD WG latest]
55+
* [JSON-LD 1.1 Processing Algorithms and API][JSON-LD WG 1.1 API], W3C Working
56+
Draft, 2018-12-14 or [newer][JSON-LD WG API latest]
57+
* [JSON-LD 1.1 Framing][JSON-LD WG 1.1 Framing], W3C Working Draft, 2018-12-14
58+
or [newer][JSON-LD WG Framing latest]
3459

35-
The [test runner][] is often updated to note or skip newer tests that are not
36-
yet supported.
60+
The [test runner][test runner] is often updated to note or skip newer tests that
61+
are not yet supported.
3762

3863
## Supported frameworks
3964

@@ -263,7 +288,10 @@ Output:
263288

264289
### Normalize
265290

266-
[Normalization](http://json-ld.github.io/normalization/spec/) (aka. canonicalization) converts the document into a graph of objects that is a canonical representation of the document that can be used for hashing, comparison, etc.
291+
[Normalization](http://json-ld.github.io/normalization/spec/) (aka.
292+
canonicalization) converts the document into a graph of objects that is a
293+
canonical representation of the document that can be used for hashing,
294+
comparison, etc.
267295

268296
```csharp
269297
var doc = JObject.Parse(_docJson);
@@ -559,7 +587,9 @@ public static void Run()
559587

560588
## Contributing
561589

562-
This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For more information see the [Code of Conduct FAQ][coc-faq] or contact [opencode@microsoft.com][ms-mail] with any additional questions or comments.
590+
This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For
591+
more information see the [Code of Conduct FAQ][coc-faq] or contact
592+
[opencode@microsoft.com][ms-mail] with any additional questions or comments.
563593

564594
Pull requests for json-ld.net are welcome, to get started install the latest
565595
tools for .NET Core:
@@ -582,7 +612,8 @@ On both Windows and all other supported operating systems, you can run
582612
This project began life as a [Sharpen][sharpen]-based auto-port from
583613
[jsonld-java][jsonld-java].
584614

585-
Documentation for this library is in part drawn from https://github.com/linked-data-dotnet/json-ld.net
615+
Documentation for this library is in part drawn from
616+
https://github.com/linked-data-dotnet/json-ld.net
586617

587618
[coc]: https://opensource.microsoft.com/codeofconduct/
588619
[coc-faq]: https://opensource.microsoft.com/codeofconduct/faq/

0 commit comments

Comments
 (0)