Massive cleanup - coding style, tiny bugs, typos and other errors

README.md

@@ -2,13 +2,16 @@
 
 Простой бот, работающий по протоколу xmpp. Его задача - банить абьюзеров чата.
 
+Этот бот автоматизирует уборку человеческой грязи. Самый важный вопрос, который следует себе задать перед его
+использованием - а не забаню ли я кого-то не того?
+
 ## Что он может?
 
-Имеет возможность соединяться с сервером по протоколу xmpp как с шифрованием, так и без. Шифрование работает по
-классическим механикам (шифрованный канал связи, без возможности коммуникации в незашифрованном виде), без поддержки
-механизма start tls. Что-то в гошке или на стороне сервера при выборе StartTLS не работает.
+Имеет возможность соединяться с сервером по протоколу xmpp как с шифрованием, так и без. (Пока что) Шифрование 
+работает по классическим механикам (шифрованный канал связи, без возможности коммуникации в незашифрованном виде), 
+без поддержки механизма start tls. Что-то в гошке или на стороне сервера при выборе StartTLS не работает.
 
-Имеет возможность заносить пользователей в бан-лист согласно заданным в конфиге правилам.
+Имеет возможность заносить пользователей в бан-лист, согласно заданным в чёрном списке правилам.
 
 ## Что он не может?
 
@@ -16,13 +19,9 @@
 * Не умеет разгадывать капчу.
 
 ## Как заставить его работать?
+Технически, бот собирается гошкой 1.20 под платформу linux. Работоспособность на других платформах не тестировалась.
 
-Этот бот автоматизирует уборку человеческой грязи. Самый важный вопрос, кторый следует себе задать еред его
-использоованием - а не забаню ли я кого-то не того?
-
-Технически, бот собирается гошкой 1.20 поод платформу linux. Работоспособность на других платформах не тестировалась.
-
-Чтобы получить готовые бинарники достаточно выполнить команду:
+Чтобы получить готовые бинарники, достаточно выполнить команду:
 
 ```bash
 make
@@ -30,8 +29,8 @@ make
 
 в итоге получится бинарник **buny-jabber-bot**, которому нужен конфиг data/config.json для работы.
 
-А также понадобятся **data/blacklist.json** и **data/whitelist.json** в которых списки правил, согласно которым *точно*
-надо банить злодеев и списки пользователей, которых *точно* не надо банить.
+А также понадобятся **data/blacklist.json** и **data/whitelist.json**, в которых находятся списки правил, злодеев и
+списки проверенных пользователей.
 
 ### Замечание
 
@@ -73,12 +72,14 @@ presence-ов тех, кто находится в комнате на моме
 ### Можно ли почистить ban-list?
 
 Да, бывают ситуации, когда по ошибке бот может забанить кого-то не того или, если не настроен белый список вообще ни в
-каком виде, то будет банить всех входящих. И если вдруг произошло так, что в бан попали все админы комнаты, то разбанить
-их может либо овнер (никто же не даст овнера боту), либо тот, кто зайдёт в комнату из-под аккаунта бота и разбанить всех
-от его имени.
+каком виде, то будет банить всех входящих.
 
-В далёких планах есть идея релизовать очистку бан-листа при запуске бота с настройкой `"wipe_bans": true`` в
-whitelist.json для канала; кроме того, есть планы такое реализовать и в качестве команды, когда у бота появятся команды.
+И если вдруг произошло так, что в бан попали все админы комнаты, то...
+
+Во-первых, давать овнера боту не надо ни при каких обстоятельствах.
+
+Во-вторых, разбанить их может только овнер, для чего надо зайти в комнату из-под аккаунта бота и разбанить всех кого
+надо.
 
 ## Дисклеймер
 
@@ -86,8 +87,8 @@ whitelist.json для канала; кроме того, есть планы т
 
 ## Благодарности
 
-Во-первых `сообществу`, без него не было бы чятиков.
+Во-первых, `сообществу`, без него не было бы чятиков.
 
-Во-вторых `batman46(new)` из конференций на `jabber.ru`, за наблюдения и за некоторые идеи, воплощённыые в этом боте.
+Во-вторых, `batman46(new)` из конференций на `jabber.ru`, за наблюдения и за некоторые идеи, воплощённые в этом боте.
 
-В-третьих `U2` из конференции `radio@conference.jabber.ru` за мысли, идеи и за позитивный настрой.
+В-третьих, `U2` из конференции `radio@conference.jabber.ru` за мысли, идеи и за позитивный настрой.