Skip to content

Commit 05ab61d

Browse files
committed
Minor README.md update
1 parent 7b534b0 commit 05ab61d

1 file changed

Lines changed: 12 additions & 6 deletions

File tree

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,16 @@ A few useful git hooks to integrate with
55

66
**The last version of this hook to support Python 2.7 & 3.6 is v1.1.15**
77

8-
<!-- mdformat-toc start --slug=github --no-anchors --maxlevel=3 --minlevel=1 -->
8+
<!-- mdformat-toc start --slug=github --no-anchors --maxlevel=4 --minlevel=1 -->
99

1010
- [Usage](#usage)
1111
- [insert-license](#insert-license)
12+
- [Comment styles](#comment-styles)
13+
- [How to specify in how many lines to search for the license header in each file](#how-to-specify-in-how-many-lines-to-search-for-the-license-header-in-each-file)
14+
- [Removing old license and replacing it with a new one](#removing-old-license-and-replacing-it-with-a-new-one)
15+
- [Handling years flexibly](#handling-years-flexibly)
16+
- [No extra EOL](#no-extra-eol)
17+
- [Fuzzy license matching](#fuzzy-license-matching)
1218
- [Handy shell functions](#handy-shell-functions)
1319
- [Useful local hooks](#useful-local-hooks)
1420
- [Forbid / remove some unicode characters](#forbid--remove-some-unicode-characters)
@@ -84,10 +90,10 @@ In case you want to remove the comment headers introduced by
8490

8591
1. Temporarily add the `--remove-header` arg in your
8692
`.pre-commit-config.yaml` ;
87-
2. Run the hook on all your files:
93+
1. Run the hook on all your files:
8894
`pre-commit run insert-license --all-files` ;
89-
3. Remove the `--remove-header` arg and update your `LICENSE.txt` ;
90-
4. Re-run the hook on all your files.
95+
1. Remove the `--remove-header` arg and update your `LICENSE.txt` ;
96+
1. Re-run the hook on all your files.
9197

9298
#### Handling years flexibly
9399

@@ -345,5 +351,5 @@ form the historical ChangeLog.
345351
### Releasing a new version
346352

347353
1. Bump version in `setup.py` & `README.md`
348-
2. `git commit -nam "New release $version" && git tag $version && git push && git push --tags`
349-
3. Publish a GitHub release.
354+
1. `git commit -nam "New release $version" && git tag $version && git push && git push --tags`
355+
1. Publish a GitHub release.

0 commit comments

Comments
 (0)