Skip to content

Commit 0be1657

Browse files
committed
docs(readme): add alternate czconfig info
you can move the .cz.json config info to package.json using the czConfig key resolves #9
1 parent 988a6bd commit 0be1657

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,15 @@ Then just add **.cz.json** to the root of your repository with the following con
4040

4141
This just tells Commitizen which adapter we actually want our contributors to use when they try to commit to this repo.
4242

43+
Alternatively, you can skip adding an additional dot file to your root directory by making **.cz.json** a part of **package.json**... just add the `czConfig` field:
44+
45+
```json
46+
...
47+
"czConfig": {
48+
"path": "node_modules/cz-conventional-changelog"
49+
}
50+
```
51+
4352
#### Congratulations your repo is Commitizen-friendly. Time to flaunt it!
4453

4554
Add the Commitizen-friendly badge to your README using the following markdown:

0 commit comments

Comments
 (0)