Skip to content

Commit b6a346a

Browse files
committed
docs: when should i use this?
Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>
1 parent c9cec45 commit b6a346a

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@ It also includes a set of utilities for customizing rules.
2929

3030
## When should I use this?
3131

32-
**TODO**: use cases.
32+
This package can be used with [`@commitlint/cli`][3] and [`@commitlint/prompt-cli`][4].
33+
34+
Commit parsing options can also be used with [`conventional-changelog`][5] and [`conventional-commits-parser`][6].
3335

3436
## Install
3537

@@ -60,12 +62,16 @@ yarn add -D @flex-development/commitlint-config@flex-development/commitlint-conf
6062

6163
## Types
6264

63-
This package is fully typed with [TypeScript][3].
65+
This package is fully typed with [TypeScript][7].
6466

6567
## Contribute
6668

6769
See [`CONTRIBUTING.md`](CONTRIBUTING.md).
6870

6971
[1]: https://commitlint.js.org/
7072
[2]: https://conventionalcommits.org/
71-
[3]: https://www.typescriptlang.org
73+
[3]: https://commitlint.js.org/#/reference-cli
74+
[4]: https://commitlint.js.org/#/guides-use-prompt
75+
[5]: https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog
76+
[6]: https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser
77+
[7]: https://www.typescriptlang.org

0 commit comments

Comments
 (0)