Skip to content

Commit c9cec45

Browse files
committed
docs: what is this?
Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>
1 parent f806d0a commit c9cec45

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ Shareable [`commitlint`][1] config enforcing [conventional commits][2]
2323

2424
## What is this?
2525

26-
**TODO**: package overview.
26+
This package exports a shareable [`commitlint`][1] configuration that enforces [conventional commits][2].
27+
28+
It also includes a set of utilities for customizing rules.
2729

2830
## When should I use this?
2931

0 commit comments

Comments
 (0)