balki/cloudflare-dns-cli
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 4 Wiki Activity

improve doc

Browse Source
This commit is contained in:
Balakrishnan Balasubramanian 2023-04-12 10:18:41 -04:00
parent 85c650d045
commit a76eff8814
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -2,9 +2,15 @@ CLI tool to manage cloudflare DNS records
## Installation ## Installation
### Using go
```bash ```bash
❯ go install go.balki.me/cloudflare-dns-cli@latest ❯ go install go.balki.me/cloudflare-dns-cli@latest
``` ```
### Using docker
```bash
❯ mkdir -p $HOME/bin
❯ docker run --pull=always --rm -v "$HOME/bin:/op" golang sh -c "go install go.balki.me/cloudflare-dns-cli@latest && install -o $(id -u) -g $(id -g) /go/bin/cloudflare-dns-cli /op/"
```
## Features ## Features
@ -33,7 +39,7 @@ Usage of cloudflare-dns-cli:
## Demo ## Demo
===> [HERE](./demo.cast) <=== ===> [HERE](https://gitea.balki.me/balki/cloudflare-dns-cli/src/branch/main/demo.cast) <===
## Similar ## Similar
* https://github.com/earlchew/cloudflare-cli * https://github.com/earlchew/cloudflare-cli
@ -42,6 +48,6 @@ Usage of cloudflare-dns-cli:
## Why another cli? ## Why another cli?
1. Keep it simple with minimum dependency and features 1. Keep it simple with minimum dependency and features
2. Uses [libdns](https://github.com/libdns) library maintained by [caddy](https://caddyserver.com) team 2. Uses [libdns](https://github.com/libdns) library maintained by [caddy](https://caddyserver.com) team.
libdns provides uniform api for many dns providers. Mostly `s/cloudflare/XYZ/` should work when moving to a different dns provider libdns provides uniform api for many dns providers. Mostly `s/cloudflare/XYZ/` should work when moving to a different dns provider