Update validation script info and add examples
authorJuan Corona <juan.carlos.corona.r@gmail.com>
Fri, 12 Oct 2018 10:51:31 +0000 (12:51 +0200)
committerBigBlueHat <byoung@bigbluehat.com>
Fri, 12 Oct 2018 16:19:25 +0000 (12:19 -0400)
README.md

index 32a5514..fd91bd1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -63,9 +63,22 @@ using the `validate` script:
 
 
 ```sh
-$ yarn validate --url ../anno1.json
+$ yarn validate --url https://raw.githubusercontent.com/w3c/web-annotation-tests/master/tools/samples/correct/anno1.json
 ```
 
+With the `--url` option you can pass in a URL or a local path to a JSON file.
+
+##### Examples
+
+Valid: 
+
+`https://raw.githubusercontent.com/w3c/web-annotation-tests/master/tools/samples/correct/anno1.json`
+
+Invalid:
+
+`https://raw.githubusercontent.com/w3c/web-annotation-tests/master/tools/samples/incorrect/anno1.json`
+
+[(More)](https://github.com/w3c/web-annotation-tests/tree/master/tools/samples)
 
 # License