From 601ae869efc2f68c14855fbd919bf22254762815 Mon Sep 17 00:00:00 2001 From: Kaan Genc Date: Sun, 23 Jan 2022 22:35:29 -0500 Subject: [PATCH] update usage instructions --- Readme.md | 8 +++++++- example.toml | 2 +- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/Readme.md b/Readme.md index 860f029..90c35a0 100644 --- a/Readme.md +++ b/Readme.md @@ -6,6 +6,12 @@ Thanks to Gandi's [LiveDNS API](https://api.gandi.net/docs/livedns/), this creat Inspired by [cavebeat's similar tool](https://github.com/cavebeat/gandi-live-dns), which seems to be unmaintained at the time I'm writing this. I decided to rewrite it in Rust as a learning project. +This tool can update both IPv4 and IPv6 addresses for one or more domains and subdomains. +It's a "one-shot" tool that's then orchestrated with a systemd timer or cron. + ## Usage -- Copy `example.toml` to \ No newline at end of file +- Copy `example.toml` to `gandi.toml` +- 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 +- Use `cargo run` to build and run the program diff --git a/example.toml b/example.toml index 346b832..63f5a98 100644 --- a/example.toml +++ b/example.toml @@ -16,7 +16,7 @@ api_key = "xxxxxxxxxxxxxxxxxxxxxxxx" name = "@" [[entry]] -# Updates both A (IPv4) and AAA (IPv6) entries for other.example.com +# Updates both A (IPv4) and AAAA (IPv6) entries for other.example.com name = "other" types = ["A", "AAAA"]