Updated readme and publish workflow
This commit is contained in:
parent
0122a02fed
commit
6432c6c125
2 changed files with 33 additions and 0 deletions
19
.github/workflows/publish.yml
vendored
Normal file
19
.github/workflows/publish.yml
vendored
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
name: Publish
|
||||
|
||||
on:
|
||||
release:
|
||||
types: [published]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
- uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: 12
|
||||
registry-url: https://registry.npmjs.org/
|
||||
- run: npm publish --access public
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
|
||||
14
README.md
14
README.md
|
|
@ -43,6 +43,20 @@ class SRT {
|
|||
}
|
||||
```
|
||||
|
||||
### Readable Stream
|
||||
A custom readable stream API is also available, example:
|
||||
|
||||
```
|
||||
const fs = require('fs');
|
||||
const dest = fs.createWriteStream('./output');
|
||||
const { SRTReadStream } = require('@eyevinn/srt');
|
||||
|
||||
const srt = new SRTReadStream('0.0.0.0', 1234);
|
||||
srt.listen(readStream => {
|
||||
readStream.pipe(dest);
|
||||
});
|
||||
```
|
||||
|
||||
## [Contributing](CONTRIBUTING.md)
|
||||
|
||||
In addition to contributing code, you can help to triage issues. This can include reproducing bug reports, or asking for vital information such as version numbers or reproduction instructions.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue