Updated documentation

1 files changed, 49 insertions, 0 deletions

diff --git a/README.md b/README.md
index 29afdeb..7cd989c 100644
--- a/README.md
+++ b/README.md
@@ -132,3 +132,52 @@ Szczegółowa dokumentacja: [pzbs-liga-ausbutler](https://github.com/emkael/pzbs
 `make ausbutler`
 
 Przeliczone zostaną wszystkie butlery zdefiniowane w podmodule `pzbs-liga-ausbutler` (z katalogu `ausbutler`).
+
+## Baza graczy
+
+Dwa polecenia operujące na bazie zawodników.
+
+### Konfiguracja
+
+Zmienna środowiskowa `LIGA_PLAYERS_DB_NAME`: nazwa bazy danych JFR Players.
+
+### Wywołania
+
+`make players` lub `./dumps/import-players.sh`
+
+Importuje `baza.csv` do bazy zawodników w stylu JFR. Nazwa bazy do importu czytana jest ze zmiennej środowiskowej `LIGA_PLAYERS_DB_NAME`.
+
+`make paid`
+
+Sprawdza status opłacenia składek wśród graczy, którzy wystąpili w turnieju teamów w danym zakresie segmentów.
+
+Wywołuje `dumps/check-all-paid.sh`, które pobiera z `dumps/.paid-queries` argumenty do wywołania, kolejno, `dumps/check-paid.sh TURNIEJ SEGMENT_OD SEGMENT_DO`.
+
+## Play-off
+
+Moduł zewnętrzny, generujący i wysyłający drabinki play-off.
+
+Szczegółowa dokumentacja: [liga-playoff](https://github.com/PZBS/liga-playoff) oraz [teamy-playoff](https://github.com/emkael/jfrteamy-playoff).
+
+## Wymagania
+
+ * [jfrteamy-playoff](https://github.com/emkael/jfrteamy-playoff#wymagania-systemowe)
+ * lftp, do wysyłania drabinek
+
+## Konfiguracja
+
+Zmienne środowiskowe:
+
+ * `LIGA_PLAYOFF_FTP_HOST`
+ * `LIGA_PLAYOFF_FTP_USER`
+ * `LIGA_PLAYOFF_FTP_PASS`
+ * `LIGA_PLAYOFF_FTP_PATH`
+
+Dane dostępu do FTP
+
+
+### Wywołanie
+
+`make playoff`
+
+Wygenerowane i wysłane zostaną wszystkie drabinki zdefiniowane w `scripts/.groups` z podmodułu `playoff`.