Skip to content

Commit 130df16

Browse files
committed
2 parents acf2295 + 99b537f commit 130df16

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,13 @@ Both the API and libary are still very much work in progress, and are subject to
66

77
## Documentation
88

9-
A [reference](https://openspace.github.io/openspace-api-js) can be found here. Please refer to `example.js` for some examples.
9+
A [reference](https://openspace.github.io/openspace-api-js) can be found here. Examples are available below:
10+
11+
### NodeJS in the terminal
12+
https://github.com/OpenSpace/openspace-api-js/blob/master/examples/example.js provides an example of how to connect from a NodeJS. To run it, run `npm example.js` in a terminal.
13+
14+
### Simple website
15+
https://github.com/OpenSpace/openspace-api-js/blob/master/examples/index.html provides an example of connecting to OpenSpace from a website. For simplicity, the example is self-contained in the index.html file.
16+
17+
### Web application
18+
For a proper example of how to interact with OpenSpace from a web application using npm, webpack and modern ES versions, please refer to https://github.com/OpenSpace/openspace-api-web-example.

0 commit comments

Comments
 (0)