Skip to content

Commit 061936a

Browse files
committed
docs(prompt): rephrase docs
1 parent 71fc40e commit 061936a

File tree

1 file changed

+11
-21
lines changed

1 file changed

+11
-21
lines changed

@commitlint/prompt/readme.md

+11-21
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
> commit prompt using .commitlintrc
1+
> commitizen adapter using .commitlintrc
22
33
# @commitlint/prompt
44

5-
## Installation
5+
## Getting started
66

77
```bash
8-
npm install --save @commitlint/prompt commitizen
8+
npm install --save @commitlint/prompt @commitlint/config-angular commitizen
9+
echo '{"extends": ["@commitlint/config-angular"]}' > .commitlintrc
910
```
1011

11-
## Configuration
12-
13-
`@commitlint/prompt` is a `commitizen` adapter.
14-
Configure `commitizen` to use it:
15-
16-
```json
12+
In package.json
13+
```
1714
{
15+
"scripts": {
16+
"commit": "git-cz"
17+
},
1818
"config": {
1919
"commitizen": {
2020
"path": "@commitlint/prompt"
@@ -23,17 +23,7 @@ Configure `commitizen` to use it:
2323
}
2424
```
2525

26-
## Usage
27-
28-
Use the [commitizen](https://github.com/commitizen/cz-cli) command line
29-
interface to start `@commitlint/prompt`.
30-
3126
```bash
32-
# do stuff in your project …
33-
34-
# … then stage your changes
35-
git add
36-
37-
# Execute the commitizen cli
38-
git-cz
27+
git add .
28+
npm run commit
3929
```

0 commit comments

Comments
 (0)