Skip to content

Commit d0c2800

Browse files
committed
docs(readme): add example section
1 parent 544d6fe commit d0c2800

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

+13
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,16 @@ In `release-it` configuration file (`.release-it.json`) add the `release-it-beau
4040
}
4141

4242
```
43+
44+
## Example
45+
46+
After install plugin and add name of the plugin in `release-it` plugin section, you can use `pnpm release-it` and follow release steps to make your release. the generated changelog will be added to our `CHANGELOG.md` and GitHub's Release-Note (if you release it to github).
47+
48+
For example, the release `v.0.1.1` of this repo was made with this command:
49+
50+
```bash
51+
pnpm release // or: pnpm run release-it
52+
```
53+
The below screenshot shows the `release-it`'s cli interactive commands:
54+
55+
![image](https://drive.google.com/uc?export=view&id=1OddYtEhPr0RrH5azc4-_W2ENY7vN4lCJ)

0 commit comments

Comments
 (0)