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