diff --git a/README.md b/README.md index 4ec8ba0..06e6b09 100644 --- a/README.md +++ b/README.md @@ -27,3 +27,19 @@ For convience, all commands can be run with; ``` make all ``` + +### Releases +### Releasing + +We can use `tbump` to automatically bump our versions in preparation of a release. + +```bash +new_version=0.1.1 +git checkout -b v$new_version +git push --set-upstream origin $(git rev-parse --abbrev-ref HEAD) +tbump new_version +``` + +The release workflow will then detect that a branch with a `v` prefix exists and create a release from it. + +Additionally, the package will be published to PyPI.