Skip to content

Commit 0486429

Browse files
committed
added titles and disclaimer to readme
1 parent 2e4ef88 commit 0486429

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,17 @@ commit-msg hook for pre-commit to verify jira issues in commit messages.
1313

1414
See also: https://github.com/pre-commit/pre-commit
1515

16+
Prerequisites
17+
=============
18+
1619
*Works only with python version >= 3.6*
1720

21+
A new version of ``pip`` that supports PEP-517/PEP-518 is required.
22+
When the setup fails try updating ``pip``.
23+
24+
25+
Usage
26+
=====
1827

1928
Add this to your project's ``.pre-commit-config.yaml`` file:
2029

@@ -58,6 +67,14 @@ Lastly install the hook:
5867
$ pre-commit install -t commit-msg
5968
6069
70+
Disclaimer
71+
==========
72+
73+
No active maintenance is intended for this project.
74+
You may leave an issue if you have a questions, bug report or feature request,
75+
but I cannot promise a quick response time.
76+
77+
6178
.. .############################### LINKS ###############################
6279
6380
.. BADGES START

0 commit comments

Comments
 (0)