Skip to content

Commit eb17d8e

Browse files
committed
docs: Improve README.
1 parent 7615bd3 commit eb17d8e

File tree

2 files changed

+37
-1
lines changed

2 files changed

+37
-1
lines changed

README-zh.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,28 @@ $ npx tauri-version major # `v0.0.2` -> `v1.0.0` - Commit message `1.0.0`
2727
$ npx tauri-version 123 # `v0.0.2` -> `v123` - 自定义版本。 commit message `123`
2828
```
2929

30+
推荐使用 `pnpx` 以运行最新版本的`tauri-version`
31+
32+
```sh
33+
$ pnpx tauri-version patch
34+
35+
# 等价于:
36+
37+
$ npx tauri-version@latest patch
38+
```
39+
3040
### 自定义commit message
3141

3242
提交消息中的 `%s` 将会被替换为版本号。
3343

3444
`npx tauri-version patch -m "chore: release v%s"`
3545
这将会将 commit message 改为:
3646
`chore: release v0.0.2`
47+
48+
### 阻止 `git commit`
49+
50+
`tauri-version patch --no-git`
51+
52+
### 选项
53+
54+
使用 `tauri-version -h` 以查看完整的帮助信息。

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,28 @@ $ npx tauri-version major # `v0.0.2` -> `v1.0.0` - Commit message `1.0.0`
2727
$ npx tauri-version 123 # `v0.0.2` -> `v123` - Customize version. commit message `123`
2828
```
2929

30+
Recommended to use `pnpx` to use the latest version of `tauri-version`.
31+
32+
```sh
33+
$ pnpx tauri-version patch
34+
35+
# Equal to:
36+
37+
$ npx tauri-version@latest patch
38+
```
39+
3040
### Custom Commit Message
3141

3242
`%s` in commit message will be replaced by version.
3343

34-
`npx tauri-version patch -m "chore: release v%s"`
44+
`tauri-version patch -m "chore: release v%s"`
3545
This will change the commit message to:
3646
`chore: release v0.0.2`
47+
48+
### Prevent `git commit`
49+
50+
`tauri-version patch --no-git`
51+
52+
### Options
53+
54+
Use `tauri-version -h` to see the whole help message.

0 commit comments

Comments
 (0)