diff --git a/README.md b/README.md index ab02269..d099bff 100644 --- a/README.md +++ b/README.md @@ -154,17 +154,66 @@ _Want another example? Let me know by creating a [github issue](https://github.c --- +## Badges + +If you appreciate this github action give it a :star: or show off with one of the badges below. + +[Deployed with FTP Deploy Action](https://github.com/SamKirkland/FTP-Deploy-Action) + +```md +[Deployed with FTP Deploy Action](https://github.com/SamKirkland/FTP-Deploy-Action) +``` + +[Deployed with FTP Deploy Action](https://github.com/SamKirkland/FTP-Deploy-Action) + +```md +[Deployed with FTP Deploy Action](https://github.com/SamKirkland/FTP-Deploy-Action) +``` + +[Deployed with FTP Deploy Action](https://github.com/SamKirkland/FTP-Deploy-Action) + +```md +[Deployed with FTP Deploy Action](https://github.com/SamKirkland/FTP-Deploy-Action) +``` + +--- + +[Website Deployed for Free with FTP Deploy Action](https://github.com/SamKirkland/FTP-Deploy-Action) + +```md +[Website Deployed for Free with FTP Deploy Action](https://github.com/SamKirkland/FTP-Deploy-Action) +``` + +[Website Deployed for Free with FTP Deploy Action](https://github.com/SamKirkland/FTP-Deploy-Action) + +```md +[Website Deployed for Free with FTP Deploy Action](https://github.com/SamKirkland/FTP-Deploy-Action) +``` + +[Website Deployed for Free with FTP Deploy Action](https://github.com/SamKirkland/FTP-Deploy-Action) + +```md +[Website Deployed for Free with FTP Deploy Action](https://github.com/SamKirkland/FTP-Deploy-Action) +``` + +--- + ## FAQ
How to exclude .git files from the publish -todo +Git files are excluded by default! If you customize the `exclude` option make sure you re-add the default options.
How to exclude a specific file or folder -todo +You can use the `exclude` option to ignore specific files/folders from the publish. Keep in mind you will need to re-add the default exclude options if you want to keep them. For example the below option excludes all `.txt` files. + +```yml +exclude: '*.txt' +``` +
@@ -189,7 +238,6 @@ jobs: ## Debugging your config locally This action is a basic wrapper around my `@samkirkland/ftp-deploy` npm package. To test your config you can install [@samkirkland/ftp-deploy](https://github.com/SamKirkland/ftp-deploy) and then convert your config to a yml action. Settings are one-to-one, this action is only a wrapper. - ## Contributing to this project To run this code locally you will need to setup docker and act to run a environment similar to the one github uses for actions. - Download/install docker for windows, make sure it is running