From 3895df69a29b9b8f17bc4da6cc0be0574095d111 Mon Sep 17 00:00:00 2001 From: Brian Sakal Date: Sun, 7 May 2023 23:22:29 -0400 Subject: [PATCH] add README: installation/publishing --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4974d4f --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Installation/Publishing + +To install this package: + +```bash +yarn config set '@torahanytime:registry' 'https://git.sakal.us/api/packages/brian/npm/' +# or use `.yarnrc`: echo '"@torahanytime:registry" "https://git.sakal.us/api/packages/brian/npm/"' >> .yarnrc +# or use `.npmrc`: echo '@torahanytime:registry=https://git.sakal.us/api/packages/brian/npm/' >> .npmrc +yarn add @sakal/fsm +``` + +To publish a new version of this package: + +```bash +yarn config set -- '//git.sakal.us/api/packages/brian/npm/:_authToken' "${GITEA_AUTH_TOKEN}" +yarn login --scope sakal +yarn build && yarn publish +``` \ No newline at end of file