From 1846e207cfe4f6f86418bfe248509d3bc6f7db9a Mon Sep 17 00:00:00 2001
From: Szymon Kaliski <hi@szymonkaliski.com>
Date: Wed, 24 Jan 2024 16:31:58 +0100
Subject: [PATCH] some info on publishing

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

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/).
+