diff --git a/README.md b/README.md index c37f5e2..acdb441 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,13 @@ Automate copying your files via ftp using this GitHub action. +View in [GitHub Marketplace](https://github.com/marketplace/actions/ftp-upload-action). +For details on how it works (and the options it sets, such as timeouts), read [`entrypoint.sh`](./entrypoint.sh). +You may be especially interested to note that: + +- the `.git` folder is not (up/down)loaded +- only newer files are (up/down)loaded + ## Example usage ``` @@ -14,7 +21,7 @@ jobs: steps: - uses: actions/checkout@v2 - name: Upload ftp - uses: genietim/ftp-action@releases/v4 + uses: ftp-upload-action@v4 with: host: ${{ secrets.FTP_SERVER }} user: ${{ secrets.FTP_USERNAME }} @@ -23,6 +30,8 @@ jobs: remoteDir: "www" ``` +Note that the `secrets.FTP_{SERVER,USERNAME,PASSWORD}` variables have to be set in the repository settings. + ## Input parameters Input parameter | Description | Required | Default