From 31b6b03c203737cfa8a8fb5266b2707415839cbf Mon Sep 17 00:00:00 2001
From: Jeffrey Sica <me@jeefy.dev>
Date: Sat, 19 Oct 2024 12:52:03 -0500
Subject: [PATCH] docs update

---
 README.md | 34 +++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2396caa..bf7da17 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,36 @@
 # Kippy
 
-Your Kubernetes Insurance Policy (KIP-Y). But y'know. Mainly for homelabs. 
+Your Kubernetes Insurance Policy (KIP-Y). But probably not for enterprises. 
 
+## Quickstart
+
+```
+kubectl apply -f https://raw.githubusercontent.com/jeefy/kippy/refs/heads/main/deployment.yaml
+```
+
+Then edit the secret and cycle the pod. :) 
+
+## What does it do?
+
+KIPPY is meant to be simple. It watches all events emitted by the Kubernetes API Server. 
+
+Any not-normal event emitted is then collected and sent to configured notification sinks every 60s.
+
+### Notification Sinks
+
+- Discord
+- Slack
+- Sendgrid
+- Generic Webhook
+
+## Prior art
+
+https://github.com/redhat-cop/k8s-notify
+
+https://github.com/opsgenie/kubernetes-event-exporter
+
+## Why?
+
+1. A lot of the previous examples are archived.
+2. I like reinventing the wheel.
+3. This matches my exact use-case.
\ No newline at end of file