release docs readme

2026-05-08 13:28:46 -04:00
parent a43c3221da
commit 9a897ef3a7
2 changed files with 22 additions and 5 deletions
--- a/README.md
+++ b/README.md
@@ -32,3 +32,20 @@ $ npm run build:mac
 # For Linux
 $ npm run build:linux
 ```
+
+### Releasing Versions
+
+Before releasing a new version, make sure that all code is committed and pushed to the remote repository. Then, update the version number in `package.json`.
+
+Create a new release tag and push it to the remote repository.
+
+```bash
+$ git tag -a <version> -m "Release <version>"
+$ git push --tags
+```
+
+Run the release script to build and package the application and upload it to the SeaweedFS bucket.
+
+```bash
+$ npm run release:<platform>
+```