Skip to content

Commit cec69ef

Browse files
committed
docs(readme): standardize terminology and capitalization across project
- Capitalize "SSH" in multiple instances for consistency - Change "This thing" to "This project" for clarity and professionalism - Capitalize "Pass" in the description of the `allenvs` option Signed-off-by: appleboy <[email protected]>
1 parent a8952eb commit cec69ef

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
[繁體中文](./README.zh-tw.md)
44
[简体中文](./README.zh-cn.md)
55

6-
[GitHub Action](https://github.com/features/actions) for executing remote ssh commands.
6+
[GitHub Action](https://github.com/features/actions) for executing remote SSH commands.
77

88
![ssh workflow](./images/ssh-workflow.png)
99

1010
[![testing main branch](https://github.com/appleboy/ssh-action/actions/workflows/main.yml/badge.svg)](https://github.com/appleboy/ssh-action/actions/workflows/main.yml)
1111

12-
This thing is built using [Golang](https://go.dev) and [drone-ssh](https://github.com/appleboy/drone-ssh). 🚀
12+
This project is built using [Golang](https://go.dev) and [drone-ssh](https://github.com/appleboy/drone-ssh). 🚀
1313

1414
## Input variables
1515

@@ -49,12 +49,12 @@ See [action.yml](./action.yml) for more detailed information.
4949
| envs | Pass environment variables to shell script | |
5050
| envs_format | Flexible configuration of environment value transfer | |
5151
| debug | Enable debug mode | false |
52-
| allenvs | pass the environment variables with prefix value of `GITHUB_` and `INPUT_` to the script | false |
52+
| allenvs | Pass the environment variables with prefix value of `GITHUB_` and `INPUT_` to the script | false |
5353
| request_pty | Request a pseudo-terminal from the server | false |
5454

5555
## Usage
5656

57-
Executing remote ssh commands.
57+
Executing remote SSH commands.
5858

5959
```yaml
6060
name: remote ssh command

0 commit comments

Comments
 (0)