Skip to content

Commit 0787b97

Browse files
committed
README.md improvements
1 parent 3d20006 commit 0787b97

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
[![][npm-shield-rtp.js]][npm-rtp.js]
44
[![][github-actions-shield-rtp.js]][github-actions-rtp.js]
5+
[![][github-actions-shield-docs]][github-actions-docs]
56

67
RTP stack for Node.js and browser written in TypeScript. **rtp.js** provides with an API to parse, generate and modify RTP and RTCP packets.
78

@@ -70,7 +71,7 @@ npm install rtp.js
7071
7172
## Note about TypeScript
7273
73-
**rtp.js** is written in TypeScript with `module: NodeNext`, meaning that TypeScript projects that have **rtp.js** as dependency must have `moduleResolution` with value "node16", 'NodeNext" or "bundler" in their `tsconfig.json` file.
74+
**rtp.js** is written in TypeScript with `module: NodeNext`, meaning that TypeScript projects that want to import **rtp.js** using its exposed entry points (`rtp.js/packets` and `rtp.js/utils`) must have `moduleResolution` with value "node16", 'NodeNext" or "bundler" in their `tsconfig.json` file.
7475
7576
## Authors
7677
@@ -85,3 +86,5 @@ npm install rtp.js
8586
[npm-rtp.js]: https://npmjs.org/package/rtp.js
8687
[github-actions-shield-rtp.js]: https://github.com/versatica/rtp.js/actions/workflows/rtp.js.yaml/badge.svg
8788
[github-actions-rtp.js]: https://github.com/versatica/rtp.js/actions/workflows/rtp.js.yaml
89+
[github-actions-shield-docs]: https://github.com/versatica/rtp.js/actions/workflows/docs.yaml/badge.svg
90+
[github-actions-docs]: https://github.com/versatica/rtp.js/actions/workflows/docs.yaml

0 commit comments

Comments
 (0)