Improve readme; Add JSON test info
authorBenjamin Young <byoung2@wiley.com>
Tue, 12 Jun 2018 14:42:36 +0000 (10:42 -0400)
committerBenjamin Young <byoung2@wiley.com>
Tue, 12 Jun 2018 14:42:36 +0000 (10:42 -0400)
README.md

index ed76bc8..a81dd32 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,24 +9,32 @@
 
 ## Development
 
-Requirements:
+##### Requirements
 
 - [node](https://nodejs.org) >= 6.x
 - [yarn](https://www.yarnpkg.com/) >= 1.5.x
 
-Setup:
+##### Setup
 
 ```sh
 $ yarn install
 ```
 
-Test:
+##### Test
 
 ```sh
 $ yarn test
 ```
 
-Run localhost server:
+By default the Web Annotation JSON-related tests will skipped. To use those
+with a specific local file you can use the `--url` parameter plus a local file
+path.
+
+```sh
+$ yarn test --url ../anno1.json
+```
+
+##### Run localhost demo server
 
 ```sh
 $ yarn start