Skip to content

Commit c90f60a

Browse files
author
Fletcher91
committed
Update readme
1 parent 50dec05 commit c90f60a

File tree

1 file changed

+4
-19
lines changed

1 file changed

+4
-19
lines changed

README.md

Lines changed: 4 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Link Library
22
*A Link to the Web*
33

4+
### [Reference](https://github.com/fletcher91/link-redux/wiki): How to use Link with React
5+
46
[![CircleCI](https://img.shields.io/circleci/build/gh/fletcher91/link-lib)](https://circleci.com/gh/fletcher91/link-lib)
57
![Code Climate coverage](https://img.shields.io/codeclimate/coverage/fletcher91/link-lib)
68

@@ -9,14 +11,14 @@ needed to work with linked data, providing high-level API's for view rendering,
911
& manipulation, and API communication. See the [link-redux](https://github.com/fletcher91/link-redux) package on how to
1012
use this in a React project.
1113

12-
To transform your Rails application into a linked-data serving beast, see our
14+
To transform your Rails application into a linked-data serving beast, see our
1315
[Active Model Serializers plugin](https://github.com/argu-co/rdf-serializers).
1416

1517
This was built at [Argu](https://argu.co), if you like what we do, these technologies
1618
or open data, send us [a mail](mailto:info@argu.co).
1719

1820
## Example
19-
See the [TODO app](https://fletcher91.github.io/link-redux-todo/#/) for a live example and
21+
See the [TODO app](https://fletcher91.github.io/link-redux-todo/#/) for a live example and
2022
[link-redux-todo](https://github.com/fletcher91/link-redux-todo) for the implementation. Mind that it isn't connected to
2123
a back-end, so it's only a demo for the view rendering mechanism.
2224

@@ -43,23 +45,6 @@ See [Link Redux](https://github.com/fletcher91/link-redux) for documentation on
4345
See the [utilities](https://github.com/fletcher91/link-lib/blob/master/src/utilities.ts) for the namespaces included by
4446
default.
4547

46-
### Changes to rdflib.js
47-
This library instantiates rdflib.js for some core tasks (low-level querying, processing), but also makes some changes to
48-
its inner workings. See the [RDFStore](https://github.com/fletcher91/link-lib/blob/master/src/RDFStore.ts) for the main
49-
wrapper and [DataProcessor](https://github.com/fletcher91/link-lib/blob/master/src/processor/DataProcessor.ts) for
50-
changes to the rdflib Fetcher.
51-
52-
Following are some of the most important changes;
53-
54-
* All named nodes MUST be instantiated via the memoization mechanism
55-
([see the utilities](https://github.com/fletcher91/link-lib/blob/master/src/utilities.ts)). This is done to enable the
56-
use of nested number arrays over string (iri) maps for performance gains.
57-
* To be able to keep track of changes, principles of immutability should be maintained, it is assumed that changes are
58-
either server provided or done via well-documented API's. Return values from the store might be frozen, and making
59-
changes directly will result in unexpected behaviour.
60-
* Some additional work is done to make the return values from rdflib more consistent (e.g. returning empty arrays over
61-
null or undefined).
62-
6348
# Contributing
6449

6550
The usual stuff. Open an issue to discuss a change, open PR's from topic-branches targeted to master for bugfixes and

0 commit comments

Comments
 (0)