From 252f0e682f12b8bd790c0e5d8e938c98c6526dbf Mon Sep 17 00:00:00 2001 From: 0x010C Date: Sat, 2 Dec 2023 17:39:39 +0100 Subject: [PATCH] Update README.md with nodeJS stuff --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 54d36b6..474d27e 100644 --- a/README.md +++ b/README.md @@ -52,11 +52,12 @@ The demo folder contain several other implementation examples. * [License](#license) ## Quick Start -Get the code: +### Get the code: * Clone github repository: `git clone https://github.com/lingua-libre/LinguaRecorder.git` * Install with [npm](https://www.npmjs.com/package/lingua-recorder): `npm install lingua-recorder` * Use a CDN: _todo_ +### Use it in browser Then include the three files stored in the src folder in your HTML page: ```html @@ -73,6 +74,13 @@ There will also be a `window.LinguaRecorder` object created, with properties `.A If you use a bundler like webpack, none of this will be present in the namespace because of the encapsulation, so you need to handle the imported functions/classes yourself. +### Use it with nodeJS +```js +{ LinguaRecorder } = require('lingua-recorder') +var recorder = new LinguaRecorder(); +... +``` + ## Examples _to do_