Minor typo/grammar fixes (#48)

Thanks for making this action! Noticed a few grammar/typos when going through the README.
This commit is contained in:
Dan Tsekhanskiy 2021-01-31 22:41:29 -05:00 committed by GitHub
parent 3c3575eb49
commit eb319b796f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -10,7 +10,7 @@
## Usage ## Usage
copy files and artifacts via SSH as below. Copy files and artifacts via SSH:
```yaml ```yaml
name: scp files name: scp files
@ -35,7 +35,7 @@ jobs:
## Input variables ## Input variables
see the [action.yml](./action.yml) file for more detail imformation. See the [action.yml](./action.yml) file for more detail information.
* host - scp remote host * host - scp remote host
* port - scp remote port, default is `22` * port - scp remote port, default is `22`
@ -70,7 +70,7 @@ SSH Proxy Setting:
### Example ### Example
Copy file via ssh password Copy file via a SSH password:
```yaml ```yaml
- name: copy file via ssh password - name: copy file via ssh password
@ -84,7 +84,7 @@ Copy file via ssh password
target: "test" target: "test"
``` ```
Copy file via ssh key Copy file via a SSH key:
```yaml ```yaml
- name: copy file via ssh key - name: copy file via ssh key
@ -112,7 +112,7 @@ Example configuration for ignore list:
target: "test" target: "test"
``` ```
Example configuration for multiple server Example configuration for multiple servers:
```diff ```diff
uses: appleboy/scp-action@master uses: appleboy/scp-action@master
@ -126,7 +126,7 @@ Example configuration for multiple server
target: "test" target: "test"
``` ```
remove the specified number of leading path elements Remove the specified number of leading path elements:
```yaml ```yaml
- name: remove the specified number of leading path elements - name: remove the specified number of leading path elements
@ -141,7 +141,7 @@ remove the specified number of leading path elements
strip_components: 1 strip_components: 1
``` ```
old target structure: Old target structure:
```sh ```sh
foobar foobar
@ -150,7 +150,7 @@ foobar
└── b.txt └── b.txt
``` ```
new target structure: New target structure:
```sh ```sh
foobar foobar