Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: merge staging to master #39

Merged
merged 2 commits into from
Jul 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 7 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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)
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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).
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@matrixai/ws",
"version": "1.2.1",
"version": "1.2.2",
"author": "Matrix AI",
"contributors": [
{
Expand Down