diff --git a/readme.md b/readme.md index 288aacb..508d001 100644 --- a/readme.md +++ b/readme.md @@ -6,3 +6,17 @@ * Website: [PushNotice.chat](https://pushnotice.chat) This is work in progress and will be developed further. + +## Installation & Usage + +To be added. + +## Release + +- Commit all changes to the `main` branch. +- Run `pnpm release` to build and release a new version. This will: + - merge the `main` branch into the `release` branch + - create a new release commit and tag + - push the `release` commit and tag to the remote repository + - on GitHub, the release will be created automatically + - GitHub Actions will also publish the release to npm