Skip to content

Commit 91bc355

Browse files
committed
chore: rename, more docs
1 parent 0d8557c commit 91bc355

File tree

2 files changed

+7
-15
lines changed

2 files changed

+7
-15
lines changed

README.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,10 @@
1-
# Test Environment for Hyperwell
1+
# Annotation Environment for Hyperwell
22

3-
You will need to have [Node.js](https://nodejs.org) installed.
3+
This application serves as an experimental annotation environment for testing real-time, collaborative annotation with the [Hyperwell gateway](https://github.com/hyperwell/gateway).
44

55
## Get started
66

7-
Install the dependencies...
8-
9-
```bash
10-
npm install
11-
```
12-
13-
... then start [Rollup](https://rollupjs.org):
14-
15-
```bash
16-
npm run dev
17-
```
7+
You will need to have [Node.js](https://nodejs.org) installed. Install the dependencies via `npm install` and start the [Rollup development server](https://rollupjs.org) via `npm run dev`.
188

199
Navigate to [localhost:5000](http://localhost:5000). You should see your app running. To test the annotation environment with a notebook provided by a Hyperwell gateway, obtain its gateway-issued URL (which is based on its ID, e.g., `http://gateway.example.com/annotatios/abcdef123`). Enter the full URL and make sure to check the Hyperwell option. By clicking the ‘Load Annotations’ button, the environment will fetch all existing annotations and establish a WebSocket connection for receiving real-time updates by collaborators.
2010

package.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
{
2-
"name": "hyperwell-test-environment",
3-
"version": "1.0.0",
2+
"name": "@hyperwell/annotation-environment",
3+
"version": "0.1.0",
4+
"private": true,
5+
"author": "Jan Kaßel <[email protected]>",
46
"scripts": {
57
"build": "rollup -c",
68
"dev": "rollup -c -w",

0 commit comments

Comments
 (0)