Adds a new bump version func to the API.

1 files changed, 16 insertions, 0 deletions

diff --git a/README.rst b/README.rst
index a13871c..a6bf947 100644
--- a/README.rst
+++ b/README.rst
@@ -107,6 +107,22 @@ Obviously, :class:`Versions <Version>` can be compared:
     >>> semantic_version.Version('0.1.1') <= semantic_version.Version('0.1.1-alpha')
     False
 
+You can also get a new version that represents a bump in one of the version levels:
+
+.. code-block:: pycon
+
+    >>> v = semantic_version.Version('0.1.1-pre+build')
+    >>> new_v = v.next_major()
+    >>> str(new_v)
+    '1.0.0'
+    >>> v = semantic_version.Version('1.1.1-pre+build')
+    >>> new_v = v.next_minor()
+    >>> str(new_v)
+    '1.2.0'
+    >>> v = semantic_version.Version('1.1.1-pre+build')
+    >>> new_v = v.next_patch()
+    >>> str(new_v)
+    '1.1.2'
 
 It is also possible to check whether a given string is a proper semantic version string: