Skip to content

Commit 8162dd8

Browse files
committed
Updated documentation
1 parent 2a4f12a commit 8162dd8

File tree

5 files changed

+75
-27
lines changed

5 files changed

+75
-27
lines changed
36.7 KB
Binary file not shown.

docs/assets/bump-my-version-logo.svg

+1-1
Loading

docs/assets/css/cards.css

+23-1
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@
9494
.card-content-title {
9595
margin-top: 0;
9696
font-weight: 400;
97-
font-size: 1.5rem;
97+
font-size: 1.25rem;
9898
line-height: 1.334;
9999
letter-spacing: 0;
100100
margin-bottom: 0.35em;
@@ -198,3 +198,25 @@
198198
.card-divider hr {
199199
margin: 0;
200200
}
201+
202+
/*************
203+
Cards - side icon
204+
*/
205+
.card-icon {
206+
min-width: 1.2rem;
207+
padding: 16px;
208+
}
209+
.card-icon .twemoji {
210+
--md-icon-size: 3rem;
211+
212+
}
213+
214+
.card-icon p {
215+
margin: 0;
216+
}
217+
218+
.card-container.horizontal {
219+
display: flex;
220+
flex-direction: row;
221+
/*align-items: center;*/
222+
}

docs/index.md

+39-23
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,45 @@ title: Bump My Version
55

66
# Bump My Version
77

8-
Bump My Version's purpose is to:
9-
10-
- Work as a part of an automated build system
11-
- Manage project versioning through the project's development life cycle
12-
- Incrementing version numbers
13-
- Serializing version numbers
14-
- Parsing version numbers
15-
- Support SemVer, CalVer, and other versioning schemes
16-
- Modify project files as part of the project's development life cycle
17-
- Work with the project's source control system
18-
- Committing changes
19-
- Tagging releases
20-
- Reading version numbers from tags
21-
22-
## Installation
23-
24-
You can download and install the latest version of this software from the Python package index (PyPI) as follows:
25-
26-
```console
27-
pip install --upgrade bump-my-version
28-
```
29-
<!--
8+
## Bump My Version's purpose is to
9+
10+
::: grid wide-gap
11+
::: card-container horizontal depth-0
12+
::: card-icon
13+
:fontawesome-solid-gear:
14+
::: card-content
15+
::: card-content-title
16+
Work as a part of an automated build system.
17+
Bump My Version works with automation workflows.
18+
19+
::: card-container horizontal depth-0
20+
::: card-icon
21+
:fontawesome-solid-magnifying-glass:
22+
::: card-content
23+
::: card-content-title
24+
Search and replace data in project files
25+
Update the version and metadata in your files when you increment your version.
26+
27+
::: card-container horizontal depth-0
28+
::: card-icon
29+
:fontawesome-solid-sliders:
30+
::: card-content
31+
::: card-content-title
32+
Manage your project's versioning
33+
- Increment and serialize version numbers
34+
- Parsing version numbers
35+
- Support SemVer, CalVer, and other versioning schemes
36+
37+
::: card-container horizontal depth-0
38+
::: card-icon
39+
:fontawesome-solid-code-commit:
40+
::: card-content
41+
::: card-content-title
42+
Work with the project's source control system
43+
- Committing changes
44+
- Tagging releases
45+
- Reading version numbers from tags
46+
3047
## Jump to section
3148

3249
::: grid wide-gap
@@ -82,4 +99,3 @@ pip install --upgrade bump-my-version
8299
{ .card-content-title }
83100

84101
Want to understand the library better? Read our explanations behind the design.
85-
-->

docs/tutorials/getting-started.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
## Installation
44

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

77
```console
8-
pip install --upgrade bump-my-version
8+
uv tool install bump-my-version
99
```
1010

1111
## Create a default configuration
@@ -57,6 +57,16 @@ $ bump-my-version show-bump 1.2.3
5757
╰─ patch ─ 1.2.4
5858
```
5959

60+
## Get the new version in a script
61+
62+
If you want to get the new version within a script, you can use the [`show`](../../reference/cli/#bump-my-version-show) method.
63+
64+
```console title="Extract the new version"
65+
$ bump-my-version show current_version
66+
1.2.3
67+
$ bump-my-version show --increment minor new_version
68+
1.3.3
69+
```
6070

6171
## Configure a file to modify when bumping
6272

0 commit comments

Comments
 (0)