From e17115da77de4fe2276b3c2504fa73c017a216c8 Mon Sep 17 00:00:00 2001
From: Jesse Hitch <jessebot@linux.com>
Date: Sun, 29 Dec 2024 18:54:49 +0100
Subject: [PATCH] Update README.md

add some basic install docs and a badge
---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.md b/README.md
index 9375ff2..c7a1789 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,18 @@
 # Pixelfed helm chart
+<a href="https://github.com/small-hack/pixelfed-chart/releases"><img src="https://img.shields.io/github/v/release/small-hack/pixelfed-chart?style=plastic&labelColor=blue&color=green&logo=GitHub&logoColor=white"></a><br />
 
 A helm chart to setup [Pixelfed](https://pixelfed.org/). Uses matt's docker [image](ghcr.io/mattlqx/docker-pixelfed) for now.
+
+
+## TLDR
+
+```bash
+# add the chart repo to your helm repos
+helm repo add pixelfed https://small-hack.github.io/pixelfed-chart
+
+# download the values.yaml and edit it with your own values such as YOUR hostname
+helm show values pixelfed/pixelfed > values.yaml
+
+# install the chart
+helm install --namespace pixelfed --create-namespace pixelfed/pixelfed --values values.yaml
+```