add documentation

rename example of configuration
2025-01-02 09:56:32 +01:00 · 2025-01-02 09:43:48 +01:00 · 2025-01-02 09:07:42 +01:00
2 changed files with 12 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -14,6 +14,18 @@ Once the configuration file is ready, start the project by specifying the path t
 $ livedns-go ./path/to/config.yml
 ```

+### Gandi
+
+Records to update are defined in the configuration.
+
+### PowerDNS
+
+Records to update are defined with comments:
+
+- `livedns-a`: set Ipv4 value
+- `livedns-aaaa`: set Ipv6 value
+- `livedns-spf`: set SPF value (first `ip4:` and `ip6:` will be updated)
+
 ## License

 [AGPL v3](https://www.gnu.org/licenses/agpl-3.0.en.html)
--- a/config.yml.example
+++ b/config.yml.example
Author	SHA1	Message	Date
Simon Vieille	227788f5ab	add documentation	2025-01-02 09:56:32 +01:00
Simon Vieille	77f8ca692f	add documentation	2025-01-02 09:43:48 +01:00
Simon Vieille	431208ab84	rename example of configuration	2025-01-02 09:07:42 +01:00