added links to API specs + node usage
This commit is contained in:
parent
7a3510251f
commit
aca6a67798
1 changed files with 20 additions and 3 deletions
23
README.md
23
README.md
|
@ -36,7 +36,7 @@ Building
|
||||||
Using Jocly in a Web page
|
Using Jocly in a Web page
|
||||||
-------------------------
|
-------------------------
|
||||||
|
|
||||||
After building Jocly, copy the `dist/browser` directory as `jocly` into your project filesystem.
|
After building Jocly, copy the `dist/browser/` directory as `jocly/` into your project filesystem.
|
||||||
|
|
||||||
Insert this line to your HTML source code:
|
Insert this line to your HTML source code:
|
||||||
````
|
````
|
||||||
|
@ -45,8 +45,25 @@ Insert this line to your HTML source code:
|
||||||
|
|
||||||
You are now ready to use the Jocly API through the `Jocly` global object.
|
You are now ready to use the Jocly API through the `Jocly` global object.
|
||||||
|
|
||||||
|
Using Jocly in a node.js application
|
||||||
|
------------------------------------
|
||||||
|
|
||||||
|
After building Jocly, the `dist/node/` directory as the Jocly module:
|
||||||
|
|
||||||
|
````Javascript
|
||||||
|
const Jocly = require("../jocly/dist/node");
|
||||||
|
````
|
||||||
|
|
||||||
|
Or, you can figure out how to use [`npm link`](https://docs.npmjs.com/cli/link) and just do:
|
||||||
|
````Javascript
|
||||||
|
const Jocly = require("jocly");
|
||||||
|
````
|
||||||
|
|
||||||
|
You are now ready to use the Jocly API through the `Jocly` entry point.
|
||||||
|
|
||||||
API Documentation
|
API Documentation
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
This section is to be written. For now, check the examples into the `examples/browser`
|
Jocly offers two distinct APIs:
|
||||||
and `examples/node` sub-directories.
|
- the [Application API](https://github.com/mi-g/jocly/wiki/Application-API) to make Web applications
|
||||||
|
- the [Game API](https://github.com/mi-g/jocly/wiki/Game-API) to create games to run with Jocly features
|
||||||
|
|
Loading…
Reference in a new issue