alemi/fedimut
1
0
Fork 0
mirror of https://git.alemi.dev/fedimut.git synced 2024-11-12 20:09:20 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: added README

Browse source
This commit is contained in:
əlemi 2024-02-28 17:15:42 +01:00
parent ad4f0610c1
commit 02d2675784
Signed by: alemi
GPG key ID: A4895B84D311642C
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md Normal file
View file

@ -0,0 +1,20 @@
# fedimut
> small tool to keep a list of mutuals on the fediverse
### mutuals
turns out being "mutuals" means something on fedi, especially for small instances relying on federated interactions!
since following means subscribing to updates, mutuals are the only people i can be sure may read my posts, and of which i can be sure i'm reading all posts
### lists
lists are an incredible tool to keep more organized timelines, however it's quite a hassle to keep them sorted and updated
### the solution
fedimut comes to the rescue!
schedule it on your pc or your vps to run periodically: it will fetch your `mutuals` list, remove all users which are no longer mutuals and add any new mutual you made in the meantime
simple and easy!
## usage
right now it's super crude: you must pass `<HOMESERVER> <USER_ID> <TOKEN>` as cli arguments to make it work, but next versions may include session storage and user_id resolution