From 2f740a0d59e83a01c5d7e6e91419ac064eaff7de Mon Sep 17 00:00:00 2001
From: Benjamin Labrecque <labrecque.benji@gmail.com>
Date: Fri, 24 Jul 2026 14:59:05 +0200
Subject: [PATCH] docs: add steps to publish new version of package

---
 README.md | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index e2a6143..d6241a1 100644
--- a/README.md
+++ b/README.md
@@ -2,10 +2,13 @@
 
 SLS-2 Online Model for beam dynamics
 
-## Packaging
+## Publish a new version of this package
 
-```
-uv build
-```
+0. Create changes in the code
+1. Bump the version in `pyproject.toml` -- try to follow `https://semver.org/`
+2. Add a git tag with the version you specified in `pyproject.toml`:
+    - `git tag v<version>`, for example: `git tag v0.3.0`
+3. Push the git tag:
+    - `git push origin tag v<version>`, for example: `git push origin tag v0.3.0` 
 
-generates `dist/*`
+The actions in `.gitea/workflows/release.yml` will then be triggered and publish the new release to `https://gitea.psi.ch/sls/OM/packages`