From 5a621c3ad28bb71e5e3d34fdae35769679c47f1b Mon Sep 17 00:00:00 2001
From: Corey Oordt <coreyoordt@gmail.com>
Date: Sun, 2 Mar 2025 08:59:15 -0600
Subject: [PATCH 1/3] Updated the Readme

BREAKING_CHANGE: Preparation for 1.0 release
---
 README.md | 21 ++++++++++++++++-----
 1 file changed, 16 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 8e7f5b05..30919aaf 100644
--- a/README.md
+++ b/README.md
@@ -23,11 +23,10 @@ Bump My Version's purpose is to:
 
 - Work as a part of an automated build system
 - Manage project versioning through the project's development life cycle
-    - Incrementing version numbers
-    - serializing version numbers
+    - Incrementing and serializing version numbers
     - parsing version numbers
     - supporting SemVer, CalVer, and other versioning schemes
-- Modify project files as part of the project's development life cycle
+- Search and replace data in project files
 - Work with the project's source control system
     - Committing changes
     - Tagging releases
@@ -35,10 +34,10 @@ Bump My Version's purpose is to:
 
 ## Installation
 
-You can download and install the latest version of this software from the Python package index (PyPI) as follows:
+To install Bump My Version as an independent tool, use [uv](https://docs.astral.sh/uv/getting-started/installation/) to install it on your system.
 
 ```console
-pip install --upgrade bump-my-version
+uv tool install bump-my-version
 ```
 
 ## Changelog
@@ -90,6 +89,18 @@ $ bump-my-version show-bump 1.2.3
 
 The default configuration only allows bumping the major, minor, or patch version. What if you wanted to support pre-release versions?
 
+### Get the new version in a script
+
+If you want to get the new version within a script, you can use the [`show`](https://callowayproject.github.io/bump-my-version/reference/cli/#bump-my-version-show) method.
+
+```console title="Extract the new version"
+$ bump-my-version show current_version
+1.2.3
+$ bump-my-version show --increment minor new_version
+1.3.3
+```
+
+
 ### Add support for pre-release versions
 
 Alter the `parse` configuration to support pre-release versions. This `parse` option uses an extended (or verbose) regular expression to extract the version components from the current version. 

From 00c4e7bcaa68040c71123d16c61aae89b525b13f Mon Sep 17 00:00:00 2001
From: Corey Oordt <coreyoordt@gmail.com>
Date: Sun, 2 Mar 2025 09:22:25 -0600
Subject: [PATCH 2/3] Added breaking change parsing

---
 .changelog-config.yaml | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/.changelog-config.yaml b/.changelog-config.yaml
index 1f88f5fb..ba4ecc60 100644
--- a/.changelog-config.yaml
+++ b/.changelog-config.yaml
@@ -34,6 +34,10 @@ summary_pipeline:
 
 # Process the commit's body for use in the changelog.
 body_pipeline:
+  - action: ParseBreakingChangeFooter
+    comment: Check for breaking changes.
+    kwargs:
+      commit_metadata: save_commit_metadata
   - action: ParseTrailers
     comment: Parse the trailers into metadata.
     kwargs:

From 26e2b835d656905cd178c917e416685608e10fb4 Mon Sep 17 00:00:00 2001
From: Corey Oordt <coreyoordt@gmail.com>
Date: Sun, 2 Mar 2025 10:23:07 -0600
Subject: [PATCH 3/3] Fixed breaking change detection !minor

---
 .changelog-config.yaml | 1 -
 1 file changed, 1 deletion(-)

diff --git a/.changelog-config.yaml b/.changelog-config.yaml
index ba4ecc60..4f0728a3 100644
--- a/.changelog-config.yaml
+++ b/.changelog-config.yaml
@@ -136,5 +136,4 @@ release_hint_rules:
     branch: master|main
   - match_result: major
     grouping: Breaking Changes
-    path: bumpversion/*
     branch: master|main