Skip to content

Commit 908b88f

Browse files
committed
Improve README
1 parent e1e7800 commit 908b88f

File tree

1 file changed

+9
-31
lines changed

1 file changed

+9
-31
lines changed

README.md

Lines changed: 9 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -30,41 +30,27 @@
3030
## Install
3131

3232
```bash
33-
$ npm install @studio/changes --save-dev
33+
npm install @studio/changes --save-dev
3434
```
3535

3636
## Configure
3737

38-
Add this to your `package.json`:
38+
```bash
39+
❯ npx changes --init
40+
```
41+
42+
This will add the following to your `package.json`:
3943

4044
```json
4145
{
4246
"scripts": {
4347
"preversion": "npm test",
4448
"version": "changes",
4549
"postversion": "git push --follow-tags && npm publish"
46-
},
47-
"devDependencies": {
48-
"@studio/changes": "^1.0.0"
4950
}
5051
}
5152
```
5253

53-
The scripts can also be added with `changes --init`, if they do not exist yet:
54-
55-
```bash
56-
$ node_modules/.bin/changes --init
57-
```
58-
59-
Or with [npx][1]:
60-
61-
```bash
62-
$ npx changes --init
63-
```
64-
65-
If the "version" script already exists, this has no effect. Existing file
66-
indentation style will be preserved.
67-
6854
## Options
6955

7056
- `--help`, `-h`: Display a help message.
@@ -83,20 +69,12 @@ indentation style will be preserved.
8369

8470
Configure your preferred editor with the `$EDITOR` environment variable.
8571

86-
## Preview changes for next release
87-
88-
If the current version in your `package.json` is already in the changelog, the
89-
`changes` command aborts and shows the unreleased commits. Preview the release
90-
notes for the next release like this:
91-
92-
```bash
93-
$ node_modules/.bin/changes
94-
```
72+
## Preview next release
9573

96-
Or with `npx`:
74+
Preview the release notes for the next release by running:
9775

9876
```bash
99-
$ npx changes
77+
npx changes
10078
```
10179

10280
![](https://javascript.studio/assets/changes-1.0.gif)

0 commit comments

Comments
 (0)