From fbe2e1531e083a05717f132316ea1b8b33eecbd4 Mon Sep 17 00:00:00 2001 From: Eric Mastro Date: Mon, 21 Feb 2022 11:19:27 +1100 Subject: [PATCH] Update readme --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4d562e2..bbc0065 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ $ nimble install lrucache ## API -See [here](./docs/index.html) +See [api docs](https://status-im.github.io/lrucache.nim) ## Usage @@ -40,3 +40,17 @@ assert: 1 notin cache assert: 2 in cache assert: 3 in cache ``` + +## lrucache devs - create a release +Put a personal access token named `GITHUB_TOKEN` in your environment [with `repo` access](https://github.com/settings/tokens/new?scopes=repo&description=release-it). You can then release interactively using `nimble release`. This will provide options for creating a release commit, a tag, and a github release, and handle the push for you. You can also achieve this non-interactively with `nimble release_patch`, `nimble release_minor`, or `nimble release_major`. +NOTE: if a `GITHUB_TOKEN` is not in your environment, but you have a git user configured for the current working directory with enough permissions for the repository, then likely the commit and tag push will work, but the release creation will fail. +```bash +# Launch interactive release process +nimble release +# Launch non-interactive release process for patch release +nimble release_patch +# Launch non-interactive release process for minor release +nimble release_minor +# Launch non-interactive release process for major release +nimble release_major +```