Update README.md

This commit is contained in:
Jason Koh 2020-11-10 13:07:09 +08:00 committed by GitHub
parent 531637c0ac
commit 77d964f11a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 6 deletions

View File

@ -9,19 +9,24 @@ git clone https://github.com/K0p1-Git/cloudflare-ddns-updater.git
``` ```
## Usage ## Usage
This script is used with crontab. Specify the frequency of running the script. This script is used with crontab. Specify the frequency of execution through crontab.
```bash ```bash
# minute | hour | (day of month) | month | (day of week) | command # ┌───────────── minute (0 - 59)
* * * * * cd /{location of repo} && /{location of repo}/cloudflare-template.sh >> /cron.log 2>&1 # │ ┌───────────── hour (0 - 23)
0 0 */3 * * echo " " > /cloudflare-autoupdate.log >> /cron.log 2>&1 # │ │ ┌───────────── day of the month (1 - 31)
# │ │ │ ┌───────────── month (1 - 12)
# │ │ │ │ ┌───────────── day of the week (0 - 6) (Sunday to Saturday 7 is also Sunday on some systems)
# │ │ │ │ │ ┌───────────── command to issue
# │ │ │ │ │ │
# │ │ │ │ │ │
# * * * * * cd /{location of repo} && /{location of repo}/cloudflare-template.sh >> /cron.log 2>&1
# 0 0 */3 * * echo " " > /cloudflare-autoupdate.log >> /cron.log 2>&1
``` ```
## Contributing ## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## Reference ## Reference
This script was made with reference from [Keld Norman](https://www.youtube.com/watch?v=vSIBkH7sxos) video. This script was made with reference from [Keld Norman](https://www.youtube.com/watch?v=vSIBkH7sxos) video.