docs: add info about extra pattern in the files when bumping

Author: woile

docs/bump.md

@@ -1,4 +1,3 @@
-
 ![Bump version](images/bump.gif)
 
 ## About
@@ -15,11 +14,11 @@ The version format follows [semantic versioning][semver].
 
 This means `MAJOR.MINOR.PATCH`
 
-| Increment | Description | Conventional commit map |
-| ------- | ----- | ------ |
-| `MAJOR` | Breaking changes introduced | `BREAKING CHANGE` |
-| `MINOR` | New features | `feat` |
-| `PATCH` | Fixes | `fix` + everything else |
+| Increment | Description                 | Conventional commit map |
+| --------- | --------------------------- | ----------------------- |
+| `MAJOR`   | Breaking changes introduced | `BREAKING CHANGE`       |
+| `MINOR`   | New features                | `feat`                  |
+| `PATCH`   | Fixes                       | `fix` + everything else |
 
 Prereleases are supported following python's [PEP 0440][pep440]
 
@@ -71,10 +70,9 @@ optional arguments:
                         manually specify the desired increment
 ```
 
-
 ## Configuration
 
-`tag_format`
+### `tag_format`
 
 Used to read the format from the git tags, and also to generate the tags.
 
@@ -90,7 +88,6 @@ cz bump --tag_format="v$minor.$major.$path$prerelease"
 
 In your `pyproject.toml`
 
-
     [tool.commitizen]
     tag_format = "v$minor.$major.$path$prerelease"
 
@@ -103,20 +100,23 @@ The variables must be preceded by a `$` sign.
 
 Suppported variables:
 
-| Variable | Description |
-| --- | ----------- |
-| `$version` | full generated version |
-| `$major` | MAJOR increment |
-| `$minor` | MINOR increment |
-| `$patch` | PATCH increment |
+| Variable      | Description                                |
+| ------------- | ------------------------------------------ |
+| `$version`    | full generated version                     |
+| `$major`      | MAJOR increment                            |
+| `$minor`      | MINOR increment                            |
+| `$patch`      | PATCH increment                            |
 | `$prerelease` | Prerelase (alpha, beta, release candidate) |
 
-`files`
+---
+
+### `files`
 
 Used to identify the files which should be updated with the new version.
-In your `pyproject.toml`
+It is also possible to provide a pattern for each file, separated by colons (`:`).
 
-Commitizen will update it's configuration (`pyproject.toml`, `.cz`) when bumping.
+Commitizen will update it's configuration file automatically (`pyproject.toml`, `.cz`) when bumping,
+regarding if the file is present or not in `files`.
 
 Some examples
 
@@ -125,30 +125,33 @@ Some examples
     [tool.commitizen]
     files = [
         "src/__version__.py",
-        "setup.py"
+        "setup.py:version"
     ]
 
-
 `.cz`
 
     [commitizen]
     files = [
         "src/__version__.py",
-        "setup.py"
+        "setup.py:version"
         ]
 
-`bump_message`
+In the example above, we can see the reference `"setup.py:version"`.
+This means that it will find a file `setup.py` and will only make a change
+in a line containing the `version` substring.
 
-Template used to specify the commit message generated when bumping
+---
 
-defaults to: `bump: version $current_version → $new_version`
+### `bump_message`
 
+Template used to specify the commit message generated when bumping
 
+defaults to: `bump: version $current_version → $new_version`
 
-| Variable | Description |
-| --- | ----------- |
+| Variable           | Description                         |
+| ------------------ | ----------------------------------- |
 | `$current_version` | the version existing before bumping |
-| `$new_version` | version generated after bumping |
+| `$new_version`     | version generated after bumping     |
 
 Some examples
 
@@ -162,7 +165,6 @@ Some examples
     [commitizen]
     bump_message = release $current_version → $new_version [skip-ci]
 
-
 ## Custom bump
 
 Read the [customizing section](./customization.md).

docs/config.md

@@ -1,40 +1,42 @@
 # Configuration
 
-**New!** Support for `pyproject.toml`
+Commitizen has support for `toml` and `ini` files.
 
-Add an entry to `pyproject.toml`.
+## pyproject.toml
 
+Add an entry to `pyproject.toml`. Recommended for **python** projects.
 
     [tool.commitizen]
     name = "cz_conventional_commits"
     version = "0.1.0"
     files = [
         "src/__version__.py",
-        "pyproject.toml"
+        "pyproject.toml:version"
     ]
 
+## INI files
 
-Also, you can create in your project folder a file called `.cz`,
-`.cz.cfg` or in your `setup.cfg` or if you want to configure the global
-default in your user's home folder a `.cz` file with the following
-information:
+Supported files: `.cz`, `.cz.cfg`, `setup.py`, and `$HOME/.cz`
+
+The format is slightly different to the `toml`, so pay attention.
+Recommended for **other languages** projects (js, go, etc).
 
     [commitizen]
     name = cz_conventional_commits
     version = 0.1.0
     files = [
         "src/__version__.py",
-        "pyproject.toml"
+        "pyproject.toml:version"
         ]
 
-The extra tab at the end (`]`) is required.
+The extra tab before the square brakets (`]`) at the end is required.
 
 ## Settings
 
 | Variable | Type | Default | Description |
 | -------- | ---- | ------- | ----------- |
 | `name` | `str` | `"cz_conventional_commits"` | Name of the commiting rules to use |
 | `version` | `str` | `None` | Current version. Example: "0.1.2" |
-| `files` | `list` | `[ ]` | Files were the version needs to be updated |
-| `tag_format` | `str` | `None` | Format for the git tag, useful for old projects, that use a convention like `"v1.2.1"`. [See more](/bump#configuration) |
-| `bump_message` | `str` | `None` | Create custom commit message, useful to skip ci. [See more](/bump#configuration) |
+| `files` | `list` | `[ ]` | Files were the version will be updated. A pattern to match a line, can also be specified, separated by `:` [See more](https://woile.github.io/commitizen/bump#files) |
+| `tag_format` | `str` | `None` | Format for the git tag, useful for old projects, that use a convention like `"v1.2.1"`. [See more](https://woile.github.io/commitizen/bump#tag_format) |
+| `bump_message` | `str` | `None` | Create custom commit message, useful to skip ci. [See more](https://woile.github.io/commitizen/bump#bump_message) |