Skip to content

Commit

Permalink
Update README.md with nodeJS stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
0x010C authored Dec 2, 2023
1 parent fabc6db commit 252f0e6
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<script src="/path/to/RecordingProcessor.js"></script>
Expand All @@ -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_

Expand Down

0 comments on commit 252f0e6

Please sign in to comment.