add release instruction

playroomkit · Feb 22, 2024 · 7c2c059 · 7c2c059
1 parent b70a0d8
commit 7c2c059
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/readme.md b/readme.md
@@ -3,3 +3,13 @@
 This SDK is a wrapper over PlayroomKit JS. Currently, it only supports WebGL exported games.
 See [PlayroomKit Unity docs](https://docs.joinplayroom.com/usage/unity) for more information.
 
+### Creating a new release
+
+Tag and push the tag to create a new release. The tag should be in the format `v0.Y.Z`. For example, `v0.0.20`.
+
+```bash
+git tag v0.Y.Z
+git push origin --tags
+```
+
+This will create a draft release [on GitHub](https://github.com/asadm/playroom-unity/releases). Edit the release to add release notes and publish it.