From 90b8f3f08a0bb03bbdce7d4e23966a2d337ff4aa Mon Sep 17 00:00:00 2001 From: Infendro Date: Sun, 14 Dec 2025 23:10:52 +0100 Subject: [PATCH] update README --- README.md | 29 +++++++++-------------------- 1 file changed, 9 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 685fa72..773daf2 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,39 @@ # DDNS -This application enables automatically updating DNS records for various providers. +DDNS is an application that enables the automatic updating of DNS records for various providers. -## Features - -* Automatically detect the current IP. - * Both IPv4 and IPv6 are supported. - * IP resolution depends on the selected service. - * ipify (default) -* Update DNS records in the selected provider. - * Porkbun -* Native (Linux) +Supported providers: +- Porkbun ## Build Execute `./gradlew assemble`. The resulting binary will be located in `./build/bin/releaseExecutable/`. -Removing the extension from the binary and adding it to `/usr/local/bin/` enables the use of `ddns` in the terminal. - ## Usage The following command updates all A and AAAA DNS records in Porkbun for `example.com` and `test.example.com`. ``` ddns porkbun \ - --key=... \ - --secret-key=... \ + --key= \ + --secret-key= \ --domain=example.com \ --subdomain= \ --subdomain=test ``` -Optionally, a file can be used to declare one or more configurations. +Alternatively, a file can be used to declare one or more configurations. The above example can be declared as follows. ``` porkbun -key=... -secret-key=... +key= +secret-key= domain=example.com subdomain= subdomain=test ``` -To use this config file, execute the command `ddns --config=...`. +To use this config file, execute the command `ddns --config=`. By default, the config file is `/etc/ddns.conf`. - -This process can be automated using systemd or cron.