Skip to content

Commit 848f10b

Browse files
committed
microfix readme: fixed quickstart
1 parent c7bfd10 commit 848f10b

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

+11-4
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,14 @@ Example of commit with multiple changes: \
2525

2626
## Quickstart
2727

28-
1. Just add this for your husky hooks in `package.json`:
28+
1. Install plugin here: \
29+
`yarn add @eigenspace/commit-linter --dev`
30+
31+
or
32+
33+
`npm install @eigenspace/commit-linter --dev`
34+
35+
2. Just add this for your husky hooks in `package.json`:
2936
```
3037
...
3138
"husky": {
@@ -38,12 +45,12 @@ Example of commit with multiple changes: \
3845
...
3946
```
4047
41-
2. Add `.commit-linter.config.json` in the root of your project and set your issue prefixes:
48+
3. Add `.commit-linter.config.json` in the root of your project and set your issue prefixes:
4249
```
4350
{
44-
"extends": "@eigenspace/commit-linter/.commit-linter.config.json",
51+
"extends": "./node_modules/@eigenspace/commit-linter/.commit-linter.base.config.json",
4552
"issuePrefixes": [
46-
"TAX/[a-z-]+"
53+
"TAX-[\d]+"
4754
]
4855
}
4956
```

0 commit comments

Comments
 (0)