Skip to content

Commit 5a621c3

Browse files
committed
Updated the Readme
BREAKING_CHANGE: Preparation for 1.0 release
1 parent 1f23c20 commit 5a621c3

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

+16-5
Original file line numberDiff line numberDiff line change
@@ -23,22 +23,21 @@ Bump My Version's purpose is to:
2323

2424
- Work as a part of an automated build system
2525
- Manage project versioning through the project's development life cycle
26-
- Incrementing version numbers
27-
- serializing version numbers
26+
- Incrementing and serializing version numbers
2827
- parsing version numbers
2928
- supporting SemVer, CalVer, and other versioning schemes
30-
- Modify project files as part of the project's development life cycle
29+
- Search and replace data in project files
3130
- Work with the project's source control system
3231
- Committing changes
3332
- Tagging releases
3433
- Reading version numbers from tags
3534

3635
## Installation
3736

38-
You can download and install the latest version of this software from the Python package index (PyPI) as follows:
37+
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.
3938

4039
```console
41-
pip install --upgrade bump-my-version
40+
uv tool install bump-my-version
4241
```
4342

4443
## Changelog
@@ -90,6 +89,18 @@ $ bump-my-version show-bump 1.2.3
9089

9190
The default configuration only allows bumping the major, minor, or patch version. What if you wanted to support pre-release versions?
9291

92+
### Get the new version in a script
93+
94+
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.
95+
96+
```console title="Extract the new version"
97+
$ bump-my-version show current_version
98+
1.2.3
99+
$ bump-my-version show --increment minor new_version
100+
1.3.3
101+
```
102+
103+
93104
### Add support for pre-release versions
94105

95106
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.

0 commit comments

Comments
 (0)