Skip to content

Commit

Permalink
Corrected descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
kacpergorka committed Oct 17, 2024
1 parent 364e9f8 commit f0d2cbf
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# 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 został przystosowany dla mniej doświadczonych programistów, którzy chcą go wykorzystać. Wszystkie zmienne na początku kodu 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 zewnętrzne 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 do `"token"` oraz dodanie ID swojego konta Discord do `"allowed_users"`. Ustawienie dozwolonych serwerów oraz dalsza konfiguracja jest przeznaczona komendom.
Wszystkie stałe na początku kodu utworzone z myślą o łatwej i szybkiej 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, 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 zewnętrzne biblioteki znajdują się w pliku `requirements.txt`. Po pobraniu plików z najaktualniejszej wersji umieszczonej w tym repozytorium GitHuba pierwszą rzeczą, jaką powinieneś zrobić przed uruchomieniem bota, jest pobranie oraz zainstalowanie owych bibliotek, zmienienie nazwy pliku `config-pattern.json` na `config.json`, a następnie w owym pliku, wprowadzenie tokenu bota do `"token"` oraz dodanie ID swojego konta Discord do `"allowed_users"`. Ustawienie dozwolonych serwerów oraz dalsza konfiguracja jest przeznaczona komendom.

# Najważniejsze funkcje bota
### Wybór kanału wysyłanych zastępstw
Expand All @@ -14,7 +14,7 @@ Bot umożliwia administratorom serwera ustawienie dedykowanego kanału tekstoweg
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.

### 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.
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 własnoręcznie zostało wcześniej umieszczone 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.

### 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.
Expand Down

0 comments on commit f0d2cbf

Please sign in to comment.