Skip to content

Commit e5aab77

Browse files
committed
docs: explain how to publish
1 parent 376b782 commit e5aab77

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,29 @@ uv run python examples/realtime_synthetic.py
108108
uv lock --upgrade
109109
```
110110

111+
### Publishing a New Version
112+
113+
The package is automatically published to PyPI when you create a GitHub release:
114+
115+
```bash
116+
# 1. Update version in pyproject.toml
117+
version = "0.0.4"
118+
119+
# 2. Commit and push
120+
git add pyproject.toml
121+
git commit -m "chore: bump version to 0.0.4"
122+
git push
123+
124+
# 3. Create a GitHub release
125+
gh release create v0.0.4 \
126+
--title "v0.0.4 - Feature summary" \
127+
--notes "## What's Changed
128+
- Feature 1
129+
- Bug fix 2"
130+
```
131+
132+
The GitHub Actions workflow will automatically build, test, and publish to PyPI.
133+
111134
## License
112135

113136
MIT

0 commit comments

Comments
 (0)