diff --git a/README.md b/README.md index 4501ca4..2471625 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ const TAG = require("text-annotation-graphs"); import TAG from "text-annotation-graphs"; ``` -Then initialise the visualisation on an element, optionally specifying the initial data set to load and any overrides to the default options. For more details, consult the full API documentation. +Then initialise the visualisation on an element, optionally specifying the initial data set to load and any overrides to the default options. For more details, consult the [full API documentation](docs/index.html). ``` const graph = TAG.tag({ @@ -84,6 +84,8 @@ Tasks are managed via [`npm` scripts](https://docs.npmjs.com/misc/scripts) and t ### Demo +See the live demo [here](demo/index.html). + After cloning the repository and installing the project dependencies via `npm install`, you can run the interactive demo using `npm run demo` and directing your browser to `localhost:8080`. To run the demo on a different port, set the `PORT` environmental variable. For example, running `PORT=9000 npm run demo` will start the demo server on `localhost:9000` instead. @@ -121,4 +123,4 @@ To regenerate the documentation, use the following `npm` task: ``` npm run generate-docs -``` \ No newline at end of file +```