diff --git a/README.md b/README.md index c08a3c9..60bca42 100644 --- a/README.md +++ b/README.md @@ -12,3 +12,15 @@ The biggest difference from existing PTY libraries is that this one works with B The Rust PTY implementation is cargo-culted from [Alacritty's Unix TTY code](https://github.com/alacritty/alacritty/blob/master/alacritty_terminal/src/tty/unix.rs). + +## Publishing + +Following ["Publish It" section from `napi-rs` docs](https://napi.rs/docs/introduction/simple-package#publish-it): + +- `npm version [major|minor|patch]` +- `git push --follow tags` + +Github Action should take care of publishing after that. + +`NPM_TOKEN` is part of the repo secrets, generated [like this](https://httptoolkit.com/blog/automatic-npm-publish-gha/). +