diff --git a/README.md b/README.md index abd91c2..884ceea 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,8 @@ The supported Janus plugins currently are: - Streaming - VideoRoom +The library is available on [npm](https://www.npmjs.com/package/janode) and the source code is on [github](https://github.com/meetecho/janode). + ## Example of usage This is just a pretty simple hello world for the echotest plugin. @@ -103,6 +105,16 @@ const admin = await Janode.connect({ ## Installation +Installing the library from npm is as easy as: + + +```bash +npm install janode +``` + +On the other hand, in case you got the code from git you must build the library through: + + ```bash npm run build ``` @@ -128,4 +140,4 @@ You need to create a bundle with the core library and the needed plugins using a - parse the `browser` field in the `package.json` If you get the code from the repo, you can find a `rollup` bundling sample in the `bundle.sh` script under `examples/browser/`. -The output will be a `bundle.js` script that defines an `App` global object with the members `Janode` and `EchoTestPlugin`. \ No newline at end of file +The output will be a `bundle.js` script that defines an `App` global object with the members `Janode` and `EchoTestPlugin`.