From 02d26757843bb4d8cb0f1f783b4459d58fcd9a48 Mon Sep 17 00:00:00 2001 From: alemi Date: Wed, 28 Feb 2024 17:15:42 +0100 Subject: [PATCH] docs: added README --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d97b9c4 --- /dev/null +++ b/README.md @@ -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 ` ` as cli arguments to make it work, but next versions may include session storage and user_id resolution