updated readme around releasing

JSainsburyPLC · Sep 20, 2019 · e11a458 · e11a458
1 parent e8d4846
commit e11a458
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -72,3 +72,17 @@ See `examples/config.json`
   }
 }
 ```
+
+## Development
+
+### Release
+
+Releases are managed using [goreleaser](https://github.com/goreleaser/goreleaser).
+
+To release:
+-	Tag the commit you want to release, e.g. `git tag v0.1.1`
+-	run `make release` 
+
+You will need a github personal access token bound to env var `GITHUB_TOKEN`
+
+You can dry run the release by running `make test-release`