From 78acb0e481362ee4363bcd100d52d9d713c45e20 Mon Sep 17 00:00:00 2001
From: Keith Bourgoin <keith.bourgoin@gmail.com>
Date: Mon, 5 Aug 2024 21:02:25 -0400
Subject: [PATCH] Fix formatting to be reST.

---
 doc/releases.rst | 43 +++++++++++++++++++++++++++++++++----------
 1 file changed, 33 insertions(+), 10 deletions(-)

diff --git a/doc/releases.rst b/doc/releases.rst
index 0142527..e0c2c5e 100644
--- a/doc/releases.rst
+++ b/doc/releases.rst
@@ -1,10 +1,33 @@
-# Cutting a new release
-
-1. Update the version number in `version.py` using semver versioning rules.
-2. Tag your commit with the new version number. ie `git tag -a v0.1.0.dev0 -m "v0.1.0.dev0"` or `git tag -a v0.1.0 -m "v0.1.0" <commit hash>`
-3. Push the tag to GitHub. `git push origin v0.1.0`
-4. Install twine and install build. `pip install twine` and `pip install build`
-5. Build the package. `python -m build`
-6. Upload the package to test.pypi.org. `twine upload --repository testpypi dist/*` and verify you can install the test package.
-7. Upload the package to pypi.org. `twine upload dist/*` and verify you can install the package.
-8. Create a new release on GitHub.
+Creating a new Streamparse Release
+==================================
+
+First, update the version number in ``version.py`` using `semantic versioning <https://semver.org>`_.
+
+Tag your commit with the new version number. For example::
+
+   git tag -a v0.1.0 -m "v0.1.0"
+
+Push the tag to GitHub::
+
+   git push origin v0.1.0
+
+Install twine and install build::
+
+   pip install twine
+   pip install build
+
+Build the package::
+
+   python -m build
+
+Upload the package to test.pypi.org::
+
+   twine upload --repository testpypi dist/*
+
+*Verify you can install it.* Then, upload it to pypi.org::
+
+   twine upload dist/*
+
+*Again, verify it installs correctly.* Then, finally, create a new release on GitHub.
+
+.. _SEMVER: https://semver.org