update readme

This commit is contained in:
Kaan Genc 2022-01-23 22:40:11 -05:00
parent 601ae869ef
commit 52af11101b
3 changed files with 9 additions and 4 deletions

2
Cargo.lock generated
View file

@ -104,7 +104,7 @@ checksum = "5827cebf4670468b8772dd191856768aedcb1b0278a04f989f7766351917b9dc"
[[package]] [[package]]
name = "die-exit" name = "die-exit"
version = "0.3.3" version = "0.3.3"
source = "git+https://github.com/SeriousBug/die.git#b804d9e970e02c7976792bfdc205e6b6dc81f1d4" source = "git+https://github.com/Xavientois/die.git?rev=31d3801f4e21654b0b28430987b1e21fc7728676#31d3801f4e21654b0b28430987b1e21fc7728676"
[[package]] [[package]]
name = "directories" name = "directories"

View file

@ -3,8 +3,6 @@ name = "gandi-rust-dns-updater"
version = "0.1.0" version = "0.1.0"
edition = "2021" edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies] [dependencies]
reqwest = { version = "0.11.7", features = ["json"] } reqwest = { version = "0.11.7", features = ["json"] }
@ -16,4 +14,5 @@ structopt = "0.3.25"
tokio = { version = "1.14.0", features = ["full"] } tokio = { version = "1.14.0", features = ["full"] }
futures = "0.3.17" futures = "0.3.17"
anyhow = "1.0" anyhow = "1.0"
die-exit = { git = "https://github.com/SeriousBug/die.git" } # TODO: Relies on a yet-unreleased interface. Switch to an actual crate release once available
die-exit = { git = "https://github.com/Xavientois/die.git", rev = "31d3801f4e21654b0b28430987b1e21fc7728676" }

View file

@ -15,3 +15,9 @@ It's a "one-shot" tool that's then orchestrated with a systemd timer or cron.
- Follow the instructions in the example config to get your API key and put it in the config - Follow the instructions in the example config to get your API key and put it in the config
- Follow the examples in the config to set up which entries you want to update - Follow the examples in the config to set up which entries you want to update
- Use `cargo run` to build and run the program - Use `cargo run` to build and run the program
> Warning!
>
> This tool does not rate limit itself, or otherwise do anything that limits how often it sends changes to Gandi's servers.
> It's up to you to use the tool properly and avoid abusing Gandi's servers. The tool is one-shot, so all you have to do is
> to avoid running it too often.