@@ -14,8 +14,8 @@ npm install --save @matrixai/ws
1414
1515To use ` WebSocketClient ` in a browser environment, you will need to polyfill:
1616
17- - [ ` buffer ` ] ( https://nodejs.org/api/buffer.html )
18- - [ ` perf_hooks ` ] ( https://nodejs.org/api/perf_hooks.html )
17+ * [ ` buffer ` ] ( https://nodejs.org/api/buffer.html )
18+ * [ ` perf_hooks ` ] ( https://nodejs.org/api/perf_hooks.html )
1919
2020A good choice for a ` buffer ` polyfill is [ ` feross/buffer ` ] ( https://github.com/feross/buffer )
2121
@@ -28,7 +28,7 @@ export { performance };
2828
2929## Development
3030
31- Run ` nix-shell ` , and once you're inside, you can use:
31+ Run ` nix develop ` , and once you're inside, you can use:
3232
3333``` sh
3434# install (or reinstall packages from package.json)
@@ -45,10 +45,6 @@ npm run lint
4545npm run lintfix
4646```
4747
48- ### Benchmarks
49-
50- View benchmarks here: https://github.com/MatrixAI/js-ws/blob/master/benches/results with https://raw.githack.com/
51-
5248### Docs Generation
5349
5450``` sh
@@ -59,26 +55,6 @@ See the docs at: https://matrixai.github.io/js-ws/
5955
6056### Publishing
6157
62- Publishing is handled automatically by the staging pipeline.
63-
64- Prerelease:
65-
66- ``` sh
67- # npm login
68- npm version prepatch --preid alpha # premajor/preminor/prepatch
69- git push --follow-tags
70- ```
71-
72- Release:
73-
74- ``` sh
75- # npm login
76- npm version patch # major/minor/patch
77- git push --follow-tags
78- ```
79-
80- Manually:
81-
8258``` sh
8359# npm login
8460npm version patch # major/minor/patch
@@ -87,3 +63,7 @@ npm publish --access public
8763git push
8864git push --tags
8965```
66+
67+ ## License
68+
69+ js-ws is licensed under Apache-2.0, you may read the terms of the license [ here] ( LICENSE ) .
0 commit comments