doc: Update README.md docs (#127)

* doc: Format README * doc: Format README * doc: Format README * doc: Format README
hustcer · Feb 2, 2025 · 3910fcc · 3910fcc
1 parent 82f8792
commit 3910fcc
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -166,13 +166,13 @@ following command installs the latest version:
 
 ### Inputs
 
-| Name             | Required | Description                                                                                                                                                   | Type   | Default   |
-| ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | --------- |
-| `version`        | no       | A valid NPM-style semver specification, such as `0.86.0`, etc. and `nightly`.                                                                                 | string | \*        |
-| `check-latest`   | no       | Set to `true` if you want to use the latest version                                                                                                           | bool   | false     |
-| `enable-plugins` | no       | Set to `true` if you want to register the bundled plugins or a comma-separated string of plugin names like `nu_plugin_polars,nu_plugin_query`, Nu v0.86 and above is required                                                                     | bool\|string   | false     |
-| `features`       | no       | Available choice: `default` or `full`, and the `full` features will include the commands from `extra` and `dataframe`. `full` can be used for `Nu` from `v0.86` to `v0.93` and was removed after `v0.93.1` | string | `default` |
-| `github-token`   | no       | Your GitHub token or PAT token | string | `${{ github.token }}` |
+| Name             | Type   | Description    |
+| ---------------- | ------ | -------------- |
+| `version`        | `string` | Optional, A valid NPM-style semver specification, such as `0.86.0`, etc. and `nightly`. Default `*`        |
+| `check-latest`   | `bool`   | Optional, Set to `true` if you want to use the latest version, default `false`   |
+| `enable-plugins` | `bool \| string`  | Optional, Set to `true` if you want to register the bundled plugins or a comma-separated string of plugin names like `nu_plugin_polars,nu_plugin_query`, Nu v0.86 and above is required, default `false` |
+| `features`       | `string` | Optional, Available choice: `default` or `full`, and the `full` features will include the commands from `extra` and `dataframe`. `full` can be used for `Nu` from `v0.86` to `v0.93` and was removed after `v0.93.1`, default: `default` |
+| `github-token`   | `string` | Optional, Your GitHub token or PAT token, default: `${{ github.token }}`   |
 
 The semver specification is passed directly to NPM's [semver package](https://www.npmjs.com/package/semver).
 This GitHub Action will install the latest matching release.

diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -159,13 +159,13 @@ jobs:
 
 ### 输入
 
-| 名称             | 必填 | 描述                                                                                                                | 类型   | 默认值    |
-| ---------------- | ---- | ------------------------------------------------------------------------------------------------------------------- | ------ | --------- |
-| `version`        | 否   | 合法的 NPM 风格的 semver 版本，such as `0.86.0` 也可以为`nightly`.                                                  | string | \*        |
-| `check-latest`   | 否   | 可以设置为 `true` 如果你想使用最新的 Nushell 版本                                                                   | bool   | false     |
-| `enable-plugins` | 否   | 可以设置为 `true` 如果你需要注册二进制包内的插件或者逗号分隔的插件名称字符串：`nu_plugin_polars,nu_plugin_query`, 需要 Nu 版本 >= v0.86                                             | bool\|string   | false     |
-| `features`       | 否   | 可选项: `default`，`full`, 设置为 `full` 将包含 `extra` 和 `dataframe` 中的命令, `full` 仅支持 `Nu` `v0.86` ~ `v0.93`, 之后版本中默认版本将包含所有特性 | string | `default` |
-| `github-token`   | 否   | 你的 GitHub Token 或者 PAT token | string | `${{ github.token }}` |
+| 名称              | 类型     |                    描述                   |
+| ---------------- | -------- | -------------------------------------------------------------- |
+| `version`        | `string` | 可选, 合法的 NPM 风格的 Semver 版本，比如 `0.86.0` 也可以为`nightly`. 默认 `*` |
+| `check-latest`   | `bool`   | 可选, 可以设置为 `true` 如果你想使用最新的 Nushell 版本, 默认 `false` |
+| `enable-plugins` | `bool\|string`   | 可选, 可以设置为 `true` 如果你需要注册二进制包内的插件或者逗号分隔的插件名称字符串：`nu_plugin_polars,nu_plugin_query`, 需要 Nu 版本 >= v0.86, 默认 `false` |
+| `features`       | `string` | 可选, 可选项: `default`/`full`, 设置为 `full` 将包含 `extra` 和 `dataframe` 中的命令, `full` 仅支持 Nu `v0.86` ~ `v0.93`, 之后版本中默认版本将包含所有特性, 默认 `default` |
+| `github-token`   | `string` | 可选, 你的 GitHub Token 或者 PAT Token, 默认为 `${{ github.token }}`  |
 
 您在 `version` 字段指定的 **semver 版本** 会直接传递给 NPM 的 [semver 包](https://www.npmjs.com/package/semver)。此 GitHub Action 将安装最新的匹配版本。