From c07330d7dd77f3dddb5080ed809a2192034bad10 Mon Sep 17 00:00:00 2001 From: Kevin Midboe Date: Sun, 19 Jan 2025 19:00:57 +0100 Subject: [PATCH] adds build badge & install documentation --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index abef47c..57a7aa2 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,21 @@ Used for advertising traefik config definitions from peer through etcd KV store. -## Configuration +[![Build Status](https://drone.schleppe.cloud/api/badges/KevinMidboe/traefik-etcd-advertiser/status.svg)](https://drone.schleppe.cloud/KevinMidboe/traefik-etcd-advertiser) + +# Install + +Install replacing `OS` and `ARCH`, e.g. `linux-amd64`. See [all releases](https://github.com/KevinMidboe/traefik-etcd-advertiser/releases/latest): ```bash -wget https://github.com/kevinmidboe/traefik-etcd-advertiser/releases/LATEST > /usr/bin/local/traefik-etcd-advertiser +curl -s -L https://github.com/KevinMidboe/traefik-etcd-advertiser/releases/latest/download/traefik-etcd-advertiser-OS-ARCH.tar | tar xvz + +# verify install +./traefik-etcd-advertiser-linux-amd64 -version ``` +## Configuration + either create `.env` configuration file or prefix environmental variables required for etcd connection: ```bash