diff --git a/README.md b/README.md index b7c25be6..fd7b1cf0 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,8 @@ npm install --save @matrixai/ws To use `WebSocketClient` in a browser environment, you will need to polyfill: -- [`buffer`](https://nodejs.org/api/buffer.html) -- [`perf_hooks`](https://nodejs.org/api/perf_hooks.html) +* [`buffer`](https://nodejs.org/api/buffer.html) +* [`perf_hooks`](https://nodejs.org/api/perf_hooks.html) A good choice for a `buffer` polyfill is [`feross/buffer`](https://github.com/feross/buffer) @@ -28,7 +28,7 @@ export { performance }; ## Development -Run `nix-shell`, and once you're inside, you can use: +Run `nix develop`, and once you're inside, you can use: ```sh # install (or reinstall packages from package.json) @@ -45,10 +45,6 @@ npm run lint npm run lintfix ``` -### Benchmarks - -View benchmarks here: https://github.com/MatrixAI/js-ws/blob/master/benches/results with https://raw.githack.com/ - ### Docs Generation ```sh @@ -59,26 +55,6 @@ See the docs at: https://matrixai.github.io/js-ws/ ### Publishing -Publishing is handled automatically by the staging pipeline. - -Prerelease: - -```sh -# npm login -npm version prepatch --preid alpha # premajor/preminor/prepatch -git push --follow-tags -``` - -Release: - -```sh -# npm login -npm version patch # major/minor/patch -git push --follow-tags -``` - -Manually: - ```sh # npm login npm version patch # major/minor/patch @@ -87,3 +63,7 @@ npm publish --access public git push git push --tags ``` + +## License + +js-ws is licensed under Apache-2.0, you may read the terms of the license [here](LICENSE). diff --git a/package-lock.json b/package-lock.json index a00d91d8..e5c21bc6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@matrixai/ws", - "version": "1.2.1", + "version": "1.2.2", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@matrixai/ws", - "version": "1.2.1", + "version": "1.2.2", "license": "Apache-2.0", "dependencies": { "@matrixai/async-cancellable": "^1.1.1", diff --git a/package.json b/package.json index 9d45b526..4ea497ad 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@matrixai/ws", - "version": "1.2.1", + "version": "1.2.2", "author": "Matrix AI", "contributors": [ {