fix(docs): close the async code fence, and give each tag a GitHub release (#43)

Two escapes in the README were written as the literal characters \n rather than
newlines, so the asynchronous usage fence neither opened nor closed. On PyPI every
section after it, supported versions, documentation links, provenance verification and
the maintenance notes, rendered inside the code block. Visible at
https://pypi.org/project/flat-api/2.0.0/

Checked the rest: all twelve fences in the README now pair up, none carry an escape, and
no other markdown file in this repository or the other three clients has the same
problem.

Publishing also now creates a GitHub release for the tag rather than leaving it bare. A
tag on its own tells a reader nothing and notifies nobody; a release carries the
version's changelog section and reaches anyone watching this repository. The notes are
extracted from CHANGELOG.md by heading, falling back to a pointer at the file when a
version has no section. This needs contents: write, which the workflow did not have.

Author: gierschv

.github/workflows/release.yml

@@ -9,7 +9,7 @@ on:
     tags: ['[0-9]+.[0-9]+.[0-9]+']
 
 permissions:
-  contents: read
+  contents: write # create the GitHub release for the tag
   id-token: write # OIDC for PyPI trusted publishing and provenance (FR-021a, FR-021b)
 
 jobs:
@@ -48,3 +48,20 @@ jobs:
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           attestations: true
+
+      # A bare tag tells a reader nothing. This gives the version a page carrying its changelog
+      # section, and it is what a watcher of this repository is notified about.
+      - name: Publish the GitHub release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          TAG="${GITHUB_REF_NAME}"
+          NOTES="$(awk -v tag="$TAG" '
+            $0 ~ "^## \\[?" tag {found=1; next}
+            found && /^## / {exit}
+            found {print}
+          ' CHANGELOG.md)"
+          [ -n "$NOTES" ] || NOTES="See CHANGELOG.md for the changes in $TAG."
+          printf '%s\n\n---\n\nInstall: `pip install flat-api==%s`\n' "$NOTES" "$TAG" \
+            > /tmp/notes.md
+          gh release create "$TAG" --title "$TAG" --notes-file /tmp/notes.md --verify-tag

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [2.0.1](https://github.com/FlatIO/api-client-python/compare/2.0.0...2.0.1) (2026-09-10)
+
+### Bug Fixes
+
+* **docs:** close the asynchronous usage code fence in the README. Two escapes had been written as the literal characters `\n` rather than newlines, so the fence never opened or closed and every section after it rendered inside the code block on PyPI.
+
 ## [1.1.3](https://github.com/FlatIO/api-client-python/compare/v1.1.2...v1.1.3) (2024-03-08)
 
 

README.md

@@ -52,10 +52,12 @@ except FlatNotFoundError:
 
 ### Asynchronous use
 
-```python\nfrom flat_api import AsyncFlatClient
+```python
+from flat_api import AsyncFlatClient
 
 client = AsyncFlatClient(access_token="YOUR_TOKEN")
-# every operation is awaitable\n```
+# every operation is awaitable
+```
 
 ## Supported versions
 

VERSION

@@ -1 +1 @@
-2.0.0
+2.0.1