Skip to content

Commit ae5975b

Browse files
committed
docs(readme): commitizen init wording changes
This changes some language surrounding commitizen init. Previously it was unclear if you'd need to both run the init command AND edit your package.json. This should make it more clear that you can EITHER run init OR edit your package.json manually. Additionally this removes reference to bitdeli analytics since it is broken.
1 parent aa25d75 commit ae5975b

File tree

1 file changed

+1
-3
lines changed

1 file changed

+1
-3
lines changed

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ commitizen init cz-conventional-changelog --save --save-exact
4040

4141
Note that if you want to force install over the top of an old adapter, you can apply the `--force` argument. For more information on this, just run `commitizen help`.
4242

43-
Then just add the `config.commitizen` key to the root of your **package.json** as shown here:
43+
The above command does three things for you. It installs the cz-conventional-changelog adapter npm module, it saves it to the package.json's dependencies or devDependencies, and lastly it add the `config.commitizen` key to the root of your **package.json** as shown here:
4444

4545
```json
4646
...
@@ -103,5 +103,3 @@ We accomplish this by letting you define which adapter you'd like to use in your
103103

104104
Special thanks to @stevelacy, whose [gulp-git](https://www.npmjs.com/package/gulp-git) project makes commitizen possible.
105105

106-
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/commitizen/cz-cli/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
107-

0 commit comments

Comments
 (0)