From 4f7fcc438db41facaa290752783041d30c569500 Mon Sep 17 00:00:00 2001
From: Evan Sherwood <evan@sherwood.io>
Date: Mon, 8 Nov 2021 11:37:36 -0800
Subject: [PATCH] docs: update readme with release instructions

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

diff --git a/README.md b/README.md
index 74990ea..178a377 100644
--- a/README.md
+++ b/README.md
@@ -64,3 +64,9 @@ NOTE: Exported code is ES6.
 ## Author
 
 [neezer](https://github.com/neezer)
+
+## Publishing
+
+Publishing of this package is not automated. To publish, make sure you have a valid `NPM_TOKEN` and `GITHUB_TOKEN` set, set `CI=true`, and run `npm run release`. All changes must be published to the remote GitHub repository before running the publish script.
+
+**IMPORTANT**: The release script will automatically tag the newer version on NPM and GitHub _**and**_ make local changes to both `package.json` and `package-lock.json`. _**DO NOT COMMIT THESE CHANGES**_. If we had CI running this properly, these changes would be ignored automatically.