Skip to content

Fixes CreativeCodingLab/TextAnnotationGraphs#36 #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 11, 2019
Merged

Fixes CreativeCodingLab/TextAnnotationGraphs#36 #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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({
Expand All @@ -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.
Expand Down Expand Up @@ -121,4 +123,4 @@ To regenerate the documentation, use the following `npm` task:

```
npm run generate-docs
```
```