Skip to content

Commit 28ac04f

Browse files
committed
docs: add poetry version and minor style changes
1 parent 87cf857 commit 28ac04f

File tree

3 files changed

+11
-9
lines changed

3 files changed

+11
-9
lines changed

docs/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,11 @@ descriptive commits.
4040

4141
## Requirements
4242

43-
[Python](https://www.python.org/downloads/) 3.7+
43+
[Python](https://www.python.org/downloads/) `3.7+`
4444

45-
[Git][gitscm] `1.8.5.2`+
45+
[Poetry](https://python-poetry.org/docs/) `1.2.0+`
46+
47+
[Git][gitscm] `1.8.5.2+`
4648

4749
## Installation
4850

docs/config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Type: `str`
8888

8989
Default: `CHANGELOG.md`
9090

91-
filename of exported changelog
91+
Filename of exported changelog
9292

9393
### `changelog_incremental`
9494

docs/init.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ configure the selected file type (`pyproject.toml`, `.cz.toml`, etc.).
1010
The `init` will help you with
1111

1212
1. Choose a convention rules (`name`)
13-
1. Choosing a version provider (`commitizen` or for example `Cargo.toml`)
14-
1. Detecting your project's version
15-
1. Detecting the tag format used
16-
1. Choosing a version type (`semver` or `pep440`)
17-
1. Whether to create the changelog automatically or not during bump
18-
1. Whether you want to keep the major as zero while building alpha software.
13+
2. Choosing a version provider (`commitizen` or for example `Cargo.toml`)
14+
3. Detecting your project's version
15+
4. Detecting the tag format used
16+
5. Choosing a version type (`semver` or `pep440`)
17+
6. Whether to create the changelog automatically or not during bump
18+
7. Whether you want to keep the major as zero while building alpha software.

0 commit comments

Comments
 (0)