Skip to content

Commit

Permalink
Merge pull request #28 from nrdxp/readme
Browse files Browse the repository at this point in the history
chore(README): add attribution and update usage
  • Loading branch information
nrdxp authored Sep 20, 2023
2 parents 7645682 + 63d6f53 commit e748667
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,18 @@ Reimplementation of [cloudflare-dyndns](https://github.com/colemickens/cloudflar

## usage

```shell
Usage: cfdyndns [OPTIONS]
```console
Usage: cfdyndns [OPTIONS] --records <RECORDS>

Options:
-r, --records <RECORDS> Comma separated DNS records to update with the host's public IP [env:
CLOUDFLARE_RECORDS=panzy.nrd.sh,panzy.nrd.sh,nrd.xp]
-t, --token <TOKEN> recommended: The CloudFlare API token to authenticate with deprecated: The CloudFlare
API key to authenticate with, also requires email [env: CLOUDFLARE_APITOKEN]
-k, --key <KEY> deprecated: The CloudFlare email to authenticate with, also requires API key [env:
CLOUDFLARE_APIKEY]
-e, --email <EMAIL> [env: CLOUDFLARE_EMAIL=]
-r, --records <RECORDS> Comma separated DNS records to update with the host's public IP [env: CLOUDFLARE_RECORDS=]
-t, --token <TOKEN> recommended: The CloudFlare API token to authenticate with [env: CLOUDFLARE_APITOKEN]
-k, --key <KEY> deprecated: The CloudFlare API key to authenticate with, also requires email [env: CLOUDFLARE_APIKEY]
-e, --email <EMAIL> deprecated: The CloudFlare email to authenticate with, also requires API key [env: CLOUDFLARE_EMAIL=]
-v, --verbose... More output per occurrence
-q, --quiet... Less output per occurrence
-6 set an AAAA record to the host's ipv6 address
-4 set an A record to the host's ipv4 address
-h, --help Print help
-V, --version Print version
```
Expand All @@ -38,3 +37,7 @@ Options:
### uninstalling systemd service

1. `make uninstall-systemd`

### acknowledgement

Special thanks to [colemickens](https://github.com/colemickens) for bootstrapping and transferring ownership of this project.

0 comments on commit e748667

Please sign in to comment.