Skip to content

Commit afc3185

Browse files
committed
chore: update readme
1 parent cfe3d8e commit afc3185

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
> Lint your conventional commits
22
3-
# @commitlint/config-conventional
3+
# @insurgentlab/commitlint-config
44

5-
Shareable `commitlint` config enforcing [conventional commits](https://conventionalcommits.org/).
6-
Use with [@commitlint/cli](https://npm.im/@commitlint/cli) and [@commitlint/prompt-cli](https://npm.im/@commitlint/prompt-cli).
5+
Shareable `commitlint` config enforcing [conventional commits](https://conventionalcommits.org/) with rules from [@insurgentlab/conventional-changelog-preset](https://github.com/insurgent-lab/conventional-changelog-preset).
6+
Use with [@commitlint/cli](https://www.npmjs.com/@commitlint/cli) and [@commitlint/prompt-cli](https://www.npmjs.com/@commitlint/prompt-cli).
77

88
## Getting started
99

1010
```sh
11-
npm install --save-dev @commitlint/config-conventional @commitlint/cli
12-
echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commitlint.config.js
11+
npm install --save-dev @insurgentlab/commitlint-config @commitlint/cli
12+
echo '{"extends": ["@insurgentlab/commitlint-config"]}' > .commitlintrc
1313
```
1414

1515
## Rules
1616

1717
### Problems
1818

19-
The following rules are considered problems for `@commitlint/config-conventional` and will yield a non-zero exit code when not met.
19+
The following rules are considered problems for `@insurgentlab/commitlint-config` and will yield a non-zero exit code when not met.
2020

2121
Consult [docs/rules](https://conventional-changelog.github.io/commitlint/#/reference-rules) for a list of available rules.
2222

0 commit comments

Comments
 (0)