From 34dfb6984782a5420fbb50406e8c0cc7796f2ed8 Mon Sep 17 00:00:00 2001 From: Koen Rouwhorst Date: Sat, 16 Jan 2021 18:34:49 +0100 Subject: [PATCH] Update README --- README.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a5fc279..1c990b2 100644 --- a/README.md +++ b/README.md @@ -30,8 +30,11 @@ jobs: uses: koenrh/dnscontrol-action@v3 with: args: check - dnscontrol_config_file: '.' # optional path to dnsconfig.js. - dnscontrol_creds_file: '.' # optional path to creds.json. + + # Optionally, if your DNSConfig files are in a non-default location, + # you could specify the paths to the config and credentials file. + config_file: 'dns/dnsconfig.js' + creds_file: 'dns/creds.json' ``` ### preview @@ -57,8 +60,11 @@ jobs: CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }} with: args: preview - dnscontrol_config_file: '.' # optional path to dnsconfig.js. - dnscontrol_creds_file: '.' # optional path to creds.json. + + # Optionally, if your DNSConfig files are in a non-default location, + # you could specify the paths to the config and credentials file. + config_file: 'dns/dnscontrol.js' + creds_file: 'dns/creds.json' ``` This is the action you probably want to run for each branch so that proposed changes @@ -132,8 +138,11 @@ jobs: CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }} with: args: push - dnscontrol_config_file: '.' # optional path to dnsconfig.js. - dnscontrol_creds_file: '.' # optional path to creds.json. + + # Optionally, if your DNSConfig files are in a non-default location, + # you could specify the paths to the config and credentials file. + config_file: 'dns/dnsconfig.js' + creds_file: 'dns/creds.json' ``` ## Credentials