diff --git a/README.md b/README.md index bd65b6e..7741e71 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,30 @@ -# brewserverblocklist +# Brew Server Blocklist -A python script to collect the server-wide blocklists from Friendica nodes to build a collection from trusted admin choices. \ No newline at end of file +Friendica publishes the server wide blocklists for other servers in the +fediverse. This script will collect the blocklists of servers of your +choice and create a merged blocklist from them that you can then import +into your own Friendica server. + +To make certain that you don't block just any instance in the fediverse +because $somebody has it on their blocklist you assign _trustlevels_ to +the correctnes of the blocklists of the other servers. Only when a server +is blocked with a total trustlevel that is above a confidence level, it +will be added to resulting blocklist automatically. Otherwise the user +will be ask if they want to add a node to their blocklist or not. + +The entries of your own servers blocklist will always gain enough trust +so that they are added on the final blocklist again. + +## Author + +* Tobias Diekershoff + +## LICENSE + + berewserverblocklist Copyright (C) 2023 Tobias Diekershoff + + This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along with this program. If not, see .