docs: Improve README.

s3xysteak · Apr 2, 2024 · eb17d8e · eb17d8e
1 parent 7615bd3
commit eb17d8e
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 1 deletion.
diff --git a/README-zh.md b/README-zh.md
@@ -27,10 +27,28 @@ $ npx tauri-version major # `v0.0.2` -> `v1.0.0` - Commit message `1.0.0`
 $ npx tauri-version 123 # `v0.0.2` -> `v123` - 自定义版本。 commit message `123`
 ```
 
+推荐使用 `pnpx` 以运行最新版本的`tauri-version`。
+
+```sh
+$ pnpx tauri-version patch
+
+# 等价于:
+
+$ npx tauri-version@latest patch
+```
+
 ### 自定义commit message
 
 提交消息中的 `%s` 将会被替换为版本号。
 
 `npx tauri-version patch -m "chore: release v%s"`
 这将会将 commit message 改为：
 `chore: release v0.0.2`
+
+### 阻止 `git commit`
+
+`tauri-version patch --no-git`
+
+### 选项
+
+使用 `tauri-version -h` 以查看完整的帮助信息。
diff --git a/README.md b/README.md
@@ -27,10 +27,28 @@ $ npx tauri-version major # `v0.0.2` -> `v1.0.0` - Commit message `1.0.0`
 $ npx tauri-version 123 # `v0.0.2` -> `v123` - Customize version. commit message `123`
 ```
 
+Recommended to use `pnpx` to use the latest version of `tauri-version`.
+
+```sh
+$ pnpx tauri-version patch
+
+# Equal to:
+
+$ npx tauri-version@latest patch
+```
+
 ### Custom Commit Message
 
 `%s` in commit message will be replaced by version.
 
-`npx tauri-version patch -m "chore: release v%s"`
+`tauri-version patch -m "chore: release v%s"`
 This will change the commit message to:
 `chore: release v0.0.2`
+
+### Prevent `git commit`
+
+`tauri-version patch --no-git`
+
+### Options
+
+Use `tauri-version -h` to see the whole help message.