From 5a883990fa8eb219e39d779706720ca908a94a8e Mon Sep 17 00:00:00 2001 From: Dave Longley Date: Tue, 8 May 2012 23:30:24 -0400 Subject: [PATCH] Update readme. --- README => README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) rename README => README.md (75%) diff --git a/README b/README.md similarity index 75% rename from README rename to README.md index 6a4c823..5bcbdf3 100644 --- a/README +++ b/README.md @@ -9,7 +9,8 @@ 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. +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 @@ -39,15 +40,24 @@ Digital Bazaar: support@digitalbazaar.com Source ------ -The source code for the PHP implementation of the JSON-LD processor +The source code for the PHP implementation of the JSON-LD API is available at: http://github.com/digitalbazaar/php-json-ld -To run the tests, checkout: +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 from the +[json-ld.org repository][json-ld.org] hosted on GitHub. https://github.com/json-ld/json-ld.org -Then run: +Then run the jsonld-tests.php application and point it at the directory +containing the tests. + + php jsonld-tests.php -d {PATH_TO_JSON_LD_ORG/test-suite/tests} + +[JSON-LD]: http://json-ld.org/ +[json-ld.org]: https://github.com/json-ld/json-ld.org -php jsonld-tests.php -d