Extend readme and include ml/json-ld documentation

sweetrdf · May 20, 2022 · c2e2244 · c2e2244
1 parent 4ebcb14
commit c2e2244
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 10 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -23,7 +23,7 @@ jobs:
         php vendor/bin/php-coveralls -v
     - name: document
       run: |
-        docker run --rm -v $(pwd):/data phpdoc/phpdoc:3 -d src -d vendor/sweetrdf/rdf-interface/src  -d vendor/sweetrdf/rdf-helpers/src/ -t docs
+        docker run --rm -v $(pwd):/data phpdoc/phpdoc:3 -d src -d vendor/sweetrdf/rdf-interface/src -d vendor/sweetrdf/rdf-helpers/src/ -d vendor/ml/json-ld -t docs
         git fetch && git checkout docs --
         for i in `ls -1 | grep -v ^docs$`; do rm -fR $i ; done
         cp -R docs/* .

diff --git a/README.md b/README.md
@@ -11,15 +11,18 @@ Originally developed for the [quickRdf](https://github.com/sweetrdf/quickRdf) li
 
 ## Supported serializations
 
-| serialization | read/write | class                          | implementation       |
-|---------------|------------|--------------------------------|----------------------|
-| n-triples     | rw         | NQuadsParser, NQuadsSerializer | own                  |
-| n-triples*    | rw         | NQuadsParser, NQuadsSerializer | own                  |
-| n-quads       | rw         | NQuadsParser, NQuadsSerializer | own                  |
-| n-quads*      | rw         | NQuadsParser, NQuadsSerializer | own                  |
-| rdf-xml       | rw         | RdfXmlParser, RdfXmlSerializer | own                  |
-| turtle        | rw         | TriGParser, TurtleSerializer   | pietercolpaert\hardf |
-| TriG          | r          | TriGParser                     | pietercolpaert\hardf |
+| serialization | read/write | class                          | implementation       | streaming[1] |
+|---------------|------------|--------------------------------|----------------------|--------------|
+| n-triples     | rw         | NQuadsParser, NQuadsSerializer | own                  | yes          |
+| n-triples*    | rw         | NQuadsParser, NQuadsSerializer | own                  | yes          |
+| n-quads       | rw         | NQuadsParser, NQuadsSerializer | own                  | yes          |
+| n-quads*      | rw         | NQuadsParser, NQuadsSerializer | own                  | yes          |
+| rdf-xml       | rw         | RdfXmlParser, RdfXmlSerializer | own                  | yes          |
+| turtle        | rw         | TriGParser, TurtleSerializer   | pietercolpaert/hardf | yes          |
+| TriG          | r          | TriGParser                     | pietercolpaert/hardf | yes          |
+| JsonLD        | rw         | JsonLdParser, JsonLdSerializer | ml/json-ld           | no           |
+
+[1] A streaming parser/serializer doesn't materialize the whole dataset in memory which makes it suitable for processing large datasets.
 
 ## Installation