From f4cbab188dd907be35f9407cb74cb35b611391d5 Mon Sep 17 00:00:00 2001
From: KevinMidboe <kevin.midboe@gmail.com>
Date: Sat, 18 Jan 2025 12:12:26 +0100
Subject: [PATCH] init README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..abef47c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# traefik etcd advertiser
+
+Used for advertising traefik config definitions from peer through etcd KV store.
+
+## Configuration
+
+```bash
+wget https://github.com/kevinmidboe/traefik-etcd-advertiser/releases/LATEST > /usr/bin/local/traefik-etcd-advertiser
+```
+
+either create `.env` configuration file or prefix environmental variables required for etcd connection:
+
+```bash
+ETCD_ENDPOINTS="localhost:2379" traefik-etc-advertiser ...
+```
+
+## Usage
+
+Pass either docker-compose or traefik dynamic config:
+
+```bash
+traefik-etcd-advertiser -filename web-service.yml -publish
+```
+