From 12b94065d6089b833744fffc8d0fe4d4ff10c424 Mon Sep 17 00:00:00 2001
From: sonny <sonnyba871@gmail.com>
Date: Sat, 3 May 2025 15:51:30 +0200
Subject: [PATCH] Add README file

---
 README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3864495
--- /dev/null
+++ b/README.md
@@ -0,0 +1,53 @@
+# Transip client
+
+A simple command line client for updating DNS records with the Transip API. It does
+so by determining the current hosts (external) IP address and accordingly updates
+the records DNS for the given domain names.
+
+## Installation
+
+Installation can be done through using uv:
+
+```
+$ uv sync --frozen --no-dev
+```
+
+Or through the provided Dockerfile:
+
+```
+$ docker image build --tag transip-client:0.7.0 .
+```
+
+Optional dependencies can be installed with:
+
+```
+$ uv sync --frozen --no-dev --extra sentry-enabled
+```
+
+For docker installations optional dependencies can be installed with:
+
+```
+$ docker image build \
+  --build-arg UV_ARGS="--extra sentry-enabled" \
+  --tag transip-client:0.7.0 .
+```
+
+## Usage
+Use the help option to show all available options:
+
+```
+transip-update --help
+```
+
+
+## Configuration
+
+The client can be configured with the following environment variables:
+
+`LOGGING_CONFIG`: Specifies the path for the [logging configuration](https://docs.python.org/3.11/library/logging.html) to be used. Note that both `LOGGING_CONFIG_SRC` and `LOGGING_CONFIG_DST` can be used when building the docker image to achieve similar results.
+
+`VERSION`: Application version. The client will try to retrieve this through git if it is not set.
+
+`SENTRY_DSN`: Optionally used for specifying Sentry's DSN
+
+`ENVIRONMENT`: Optionally used for specifying the environment in Sentry