From 6d6fca12b9becc58d265e6b45e9afd645f91d861 Mon Sep 17 00:00:00 2001
From: Venrey <venrey@venreys-lair.xyz>
Date: Fri, 5 Apr 2024 23:32:50 +0000
Subject: [PATCH] Update README.md

---
 README.md | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 386a047..07e4e1a 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,12 @@
-# SharkeyForget
+### SharkeyForget
 
-A quick script to delete all your fedi posts 
\ No newline at end of file
+A quick script to delete all your fedi posts, only tested on sharkey so use at your own risk
+
+#How to use
+
+1. run 'git clone https://git.venreys-lair.xyz/Venrey/SharkeyForget.git'
+2. open 'forget.py', edit 'token', 'UserID', 'NoteEndpoint', 'DeleteEndpoint' to the values specific to your instance
+3. run 'python forget.py'
+
+##Warning 
+This will delete all your notes including private ones and messages. Do not use unless this is your intention
\ No newline at end of file