First stable release

.gitignore

@@ -1,3 +1,2 @@
 *.json
-*.txt
-*.log
+*.log

README.md

@@ -1,18 +1,20 @@
 # Aktualizacja zastępstw wysyłana na platformie Discord
+> Kod bota przystosowany jest do zastępstw [Zespołu Szkół Elektronicznych w Bydgoszczy](https://zastepstwa.zse.bydgoszcz.pl/). Jesteś uczniem tej szkoły? [Dodaj bota](https://discord.com/oauth2/authorize?client_id=1278769348822962196&permissions=8&integration_type=0&scope=applications.commands+bot), a następnie skontaktuj się z jego administratorami. Wszystkie ważne informacje znajdziesz, używając komendy `/informacje`.
+
+# Informacje techniczne
 Bot na platformie Discord udostępnia aktualizacje zastępstw, które pobiera ze strony internetowej korzystającej z usługi [Zastępstwa Optivum firmy VULCAN](https://duckduckgo.com/?t=h_&q=Zast%C4%99pstwa+Optivum+firmy+VULCAN&ia=web).
-> Kod bota przystosowany jest do zastępstw [Zepołu Szkół Elektronicznych w Bydgoszczy](https://zastepstwa.zse.bydgoszcz.pl/).
 
-## Konfiguracja kanału aktualizacji
-Bot umożliwia administratorom ustawienie dedykowanego kanału, przy pomocy komendy `/skonfiguruj`, na który będą wysyłane aktualizacje. Dzięki temu wszystkie istotne informacje trafią do wybranej grupy użytkowników.
+Kod bota został przystosowany dla mniej doświadczonych programistów, którzy chcą go wykorzystać. Wszystkie zmienne utworzone z myślą o łatwej możliwości wprowadzania zmian posiadają dołączony komentarz z dokładnym opisem ich funkcji. Jeżeli wystąpią jakiekolwiek błędy z zakresu poprawnego wysyłania zastępstw, również innych szkół, utwórz issue z dokładnym opisem błędu oraz jeżeli błąd dotyczy innej szkoły, to dołącz link do strony, z której bot pobiera zastępstwa, a postaram się odpowiednio naprawić owe błędy. Wszystkie niezbędne do prawidłowego działania kodu biblioteki znajdują się w pliku `requirements.txt`. Po pobraniu plików z repozytorium GitHuba pierwszą rzeczą, jaką powinieneś zrobić przed uruchomieniem bota, jest zmienienie nazwy pliku `config-pattern.json` na `config.json`, a następnie w tym samym pliku wprowadzenie tokenu bota oraz dodanie ID swojego konta Discord do `"allowed_users"`. Ustawienie dozwolonych serwerów oraz dalsza konfiguracja jest przeznaczona komendom.
 
-## Filtracja zastępstw
-Administratorzy serwera mogą skonfigurować filtrowanie zastępstw, przy pomocy komendy `/skonfiguruj`. Pozwala to na wysyłanie aktualizacji tylko do określonych grup, co pomaga w znalezieniu swoich zastępstw.
+# Najważniejsze funkcje bota
+### Wybór kanału wysyłanych zastępstw
+Bot umożliwia administratorom serwera ustawienie dedykowanego kanału tekstowego, na który będą wysyłane zastępstwa, przy pomocy komendy `/skonfiguruj`. Dzięki temu wszystkie istotne informacje trafią do wybranej grupy użytkowników.
 
-## Bezpieczeństwo
-Bot, który znajduję się na serwerze, nie będzie działał bez uprzedniego dodania ID serwera do pliku konfiguracyjnego bota. Taką czynność mogą dokonać osoby za pomocą komendy `/zarządzaj`, których ID zostało wcześniej umieszczone własnoręcznie w pliku konfiguracyjnym bota przez administratora kodu. Takie działanie ma zapewnić bezpieczeństwo, niezawodność oraz zapobiegać przeciążeniom bota.
+### Filtracja zastępstw po klasach
+Administratorzy serwera mogą skonfigurować filtrowanie zastępstw, również przy użyciu tej samej komendy `/skonfiguruj`. Pozwala to na wysyłanie aktualizacji tylko dla wybranych klas, co pomaga w znalezieniu swoich zastępstw.
 
-## Przyjazny interfejs
-Dzięki wykorzystaniu elementów interfejsu użytkownika Discorda, takich jak selektory, bot oferuje intuicyjny sposób konfiguracji oraz przejrzyste i czytelne zastępstwa, które bot umieszcza na wskazanym wcześniej kanale.
+### Bezpieczeństwo
+Bot, który znajduję się na serwerze, nie będzie działał bez uprzedniego dodania ID serwera do pliku konfiguracyjnego bota. Taką czynność mogą dokonać osoby, których ID zostało wcześniej umieszczone własnoręcznie w pliku konfiguracyjnym bota przez administratora kodu, za pomocą komendy `/zarządzaj`. Takie działanie ma zapobiec nieautoryzowanym wykorzystaniem bota bez świadomości jego administratora.
 
-## Przechowywanie konfiguracji
-Bot przechowuje konfiguracje serwerów w jednym pliku, co pozwala na łatwe zapisywanie i ładowanie ustawień pomiędzy sesjami. Jest to szczególnie przydatne w przypadku wielokrotnych konfiguracji na różnych serwerach.
+### Przyjazny interfejs
+Dzięki wykorzystaniu elementów interfejsu udostępnionych przez Discorda takich jak selektory czy przyciski, bot oferuje intuicyjny sposób konfiguracji oraz przejrzyście i czytelnie sformatowane zastępstwa, które umieszcza na wskazanym wcześniej kanale.

config-pattern.json

@@ -1,18 +1,10 @@
 {
     "token": "TWÓJ-TOKEN",
     "allowed_guilds": [
-        "0123456789123456789",
-        "9876543210987654321"
     ],
     "guilds": {
-        "9876543210987654321": {
-            "channel_id": "0123456789123456789"
-        },
-        "0123456789123456789": {
-            "channel_id": "9876543210987654321"
-        }
     },
     "allowed_users": [
-        "0123456789123456789"
+        "TWOJE-ID"
     ]
-}
+}