Skip to content

Commit 7c86299

Browse files
committed
Readme: Fixes to README.md text
1 parent 89d27c0 commit 7c86299

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,14 @@ const TAG = require("text-annotation-graphs");
6767
import TAG from "text-annotation-graphs";
6868
```
6969

70-
Then initialise the visualisation on an element, optionally specifying the initial data set to load. For more details, consult the full API documentation.
70+
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.
7171

7272
```
7373
const graph = TAG.tag({
7474
container: $container,
75-
data: <...>,
76-
format: "json"
75+
data: {...},
76+
format: "odin",
77+
options: {...}
7778
});
7879
```
7980

@@ -85,6 +86,9 @@ Tasks are managed via [`npm` scripts](https://docs.npmjs.com/misc/scripts) and t
8586

8687
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`.
8788

89+
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.
90+
91+
8892
### Building the source
8993

9094
TAG is written in ES6, and uses [Sass](https://sass-lang.com/) for its styles.

0 commit comments

Comments
 (0)