Browse Source

Add project description

pull/3/head
Toromino 1 year ago
parent
commit
95931ae858
1 changed files with 20 additions and 0 deletions
  1. 20
    0
      README.md

+ 20
- 0
README.md View File

@@ -1,3 +1,23 @@
1 1
 # Pubcleaner
2 2
 
3
+Pubcleaner is a tool that deletes your old posts on federated social networks like Mastodon or Pleroma.
3 4
 
5
+# Why it is useful
6
+
7
+On a federated network other servers save copies of your posts in order to provide them to their users.
8
+But most ActivityPub-compatible software does not automatically delete their copies after some time,
9
+therefore a server might still have copies of your posts after your profile has already been deleted and is long gone.
10
+
11
+This tool makes sure the server you are registered on sends out individual `Delete` requests for each of your posts.
12
+
13
+# How to use it
14
+
15
+There a no public builds available yet, but you can build it yourself:
16
+
17
+```
18
+git clone https://git.cybre.club/foxhkron/pubcleaner.git
19
+cd pubcleaner
20
+cargo run
21
+```
22
+
23
+Pubcleaner will interactively ask your for your servers' parameters, if you do not specify arguments.

Loading…
Cancel
Save