From 2a55af298051c4729d30c95077cf8c660029d7b1 Mon Sep 17 00:00:00 2001
From: Nicklas Reincke <nickreynke@gmail.com>
Date: Fri, 7 Aug 2020 09:03:51 +0200
Subject: [PATCH] docs: added docs on how to bump the version

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/README.md b/README.md
index 4be15cb..f6a0ce7 100644
--- a/README.md
+++ b/README.md
@@ -62,6 +62,33 @@ the `repository-url` is `https://upload.pypi.org/legacy/`.
 >
 > `pipenv run twine upload --repository-url https://upload.pypi.org/legacy/ dist/*`
 
+## Version bumping (releasing)
+
+All of the following will generate a `<major>.<minor>.<patch>-dev<build>` version:
+
+```bash
+# Major
+pipenv run bumpversion major --message 'chore: release {new_version}'
+
+# Minor
+pipenv run bumpversion minor --message 'chore: release {new_version}'
+
+# Patch
+pipenv run bumpversion patch --message 'chore: release {new_version}'
+```
+
+To bump up the `<build>` number, run the following:
+
+```bash
+pipenv run bumpversion build --message 'chore: release {new_version}'
+```
+
+To do a final release of the current `<major>.<minor>.<patch>` part, run the following:
+
+```bash
+pipenv run bumpversion release --message 'chore: release {new_version}'
+```
+
 ## History
 
 This module was originally based on a GEDCOM parser written by