From 9afb8c6d260b3c4db6a52fb18b05c0d9c19848f1 Mon Sep 17 00:00:00 2001
From: Slawomir Koszewski <slawek@koszewscy.waw.pl>
Date: Sun, 6 Sep 2026 19:39:10 +0200
Subject: [PATCH] Update README and pyproject.toml for Gitea package registry
 installation and publishing instructions

---
 README.md      | 29 +++++++++++++++++++++++++++++
 pyproject.toml |  1 +
 2 files changed, 30 insertions(+)

diff --git a/README.md b/README.md
index 75ad85e..6dd33c8 100644
--- a/README.md
+++ b/README.md
@@ -43,6 +43,35 @@ PYTHONPATH=/path/to/python-helpers python3 -m python_helpers.cli.token_decoder -
 The module path replaces the installed command's short hyphenated name; the underlying `main()`
 and behavior are identical.
 
+### Install from the Gitea package registry
+
+```bash
+pip install --index-url https://<username>:<token>@<gitea-host>/api/packages/<owner>/pypi/simple python-helpers
+```
+
+## Publishing
+
+Add the registry to `~/.pypirc`:
+
+```
+[distutils]
+index-servers = gitea
+
+[gitea]
+repository = https://<gitea-host>/api/packages/<owner>/pypi
+username = <username>
+password = <token>
+```
+
+```bash
+pip install build twine
+python3 -m build
+python3 -m twine upload --repository gitea dist/*
+```
+
+> **Note**: a name and version already in the registry cannot be republished. Raise `version`
+> in `pyproject.toml` before each upload.
+
 ## Library
 
 - `console`: colored console output and the `fail()` helper used to report errors and exit
diff --git a/pyproject.toml b/pyproject.toml
index b1772c1..5ab95eb 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -6,6 +6,7 @@ build-backend = "setuptools.build_meta"
 name = "python-helpers"
 version = "1.0.0"
 description = "Generic Python helpers and command-line tools with no cloud-specific logic"
+readme = "README.md"
 requires-python = ">=3.9"
 
 [project.scripts]