Skip to content

Commit 44343c1

Browse files
committed
chore(readme): add badges and some links
1 parent e771125 commit 44343c1

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
1-
> Lint your conventional commits
1+
# **Insurgent Lab's commitlint configuration**
22

3-
# @insurgentlab/commitlint-config
3+
[![npm](https://img.shields.io/npm/v/@insurgentlab/commitlint-config)](https://www.npmjs.com/package/@insurgentlab/commitlint-config)
4+
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/insurgent-lab/commitlint-config/release.yml?branch=main)](https://github.com/insurgent-lab/commitlint-config/actions/workflows/release.yml)
5+
[![Codecov](https://codecov.io/gh/insurgent-lab/commitlint-config/branch/main/graph/badge.svg)](https://codecov.io/gh/insurgent-lab/commitlint-config)
6+
[![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://github.com/insurgent-lab/commitlint-config/issues/5)
47

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).
8+
[conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) preset built from a list of [conventional commit types](src/types.js) (similar to [conventional-commit-types](https://github.com/commitizen/conventional-commit-types)).
9+
Also provides [release rules](https://github.com/semantic-release/commit-analyzer#releaserules) configuration for [@semantic-release/commit-analyzer](https://github.com/semantic-release/commit-analyzer#releaserules).
10+
11+
Shareable [`commitlint`](https://github.com/conventional-changelog/commitlint) config enforcing [conventional commits](https://conventionalcommits.org/) with rules from [@insurgentlab/conventional-changelog-preset](https://github.com/insurgent-lab/conventional-changelog-preset).
12+
Use with [@commitlint/cli](https://www.npmjs.com/package/@commitlint/cli) and [@commitlint/prompt-cli](https://www.npmjs.com/package/@commitlint/prompt-cli).
713

814
## Getting started
915

0 commit comments

Comments
 (0)