Merge pull request #13 from ctrleffive/patch-1

syntax highlighting types in README changed
This commit is contained in:
Sam Kirkland 2019-09-18 09:29:20 -05:00 committed by GitHub
commit 67f266cff8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -5,7 +5,7 @@ Automate deploying websites and more with this GitHub action.
![Action](images/action-preview.gif) ![Action](images/action-preview.gif)
### Usage Example (Your_Project/.github/workflows/main.yml) ### Usage Example (Your_Project/.github/workflows/main.yml)
```shell ```yml
on: push on: push
name: Publish Website name: Publish Website
jobs: jobs:
@ -70,7 +70,7 @@ You can use as many arguments as you want, seperate them with a space
## Common Examples ## Common Examples
### Build and Publish React/Angular/Vue/Node Website ### Build and Publish React/Angular/Vue/Node Website
Make sure you have an npm script named 'build'. This config should work for most node built websites Make sure you have an npm script named 'build'. This config should work for most node built websites
```shell ```yml
on: push on: push
name: Build and Publish Front End Framework Website name: Build and Publish Front End Framework Website
jobs: jobs:
@ -105,7 +105,7 @@ jobs:
### Log only dry run: Use this mode for testing ### Log only dry run: Use this mode for testing
Ouputs a list of files that will be created/modified to sync your source without making any actual changes Ouputs a list of files that will be created/modified to sync your source without making any actual changes
```shell ```yml
on: push on: push
name: Publish Website Dry Run name: Publish Website Dry Run
jobs: jobs:
@ -136,7 +136,7 @@ jobs:
* Note: This will exclude all folders and files that start with `.git` no matter the folder they're in * Note: This will exclude all folders and files that start with `.git` no matter the folder they're in
#### Deprecated main.workflow config (used for beta/legacy apps that haven't been migrated to .yaml workflows yet) #### Deprecated main.workflow config (used for beta/legacy apps that haven't been migrated to .yaml workflows yet)
```json ```workflow
action "FTP-Deploy-Action" { action "FTP-Deploy-Action" {
uses = "SamKirkland/FTP-Deploy-Action@master" uses = "SamKirkland/FTP-Deploy-Action@master"
secrets = ["FTP_USERNAME", "FTP_PASSWORD", "FTP_SERVER"] secrets = ["FTP_USERNAME", "FTP_PASSWORD", "FTP_SERVER"]