# HG changeset patch
# User Laman
# Date 2021-10-20 15:12:28
# Node ID 004a7cde6de0fc2f5e530bb096c6184300a70688
# Parent  455d2af528a822b83cba294dd97c8d5a88c8fde3

a readme

diff --git a/readme.md b/readme.md
new file mode 100644
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,7 @@
+A script to detect rank changes among Czech go players.
+
+It downloads the rating history, reads and parses the file, filters the relevant results, constructs the rank history for each player and outputs the records between the requested dates.
+
+For the usage just run `python3 rank_progress.py --help`.
+
+Licensed under GNU GPL v3 or newer. See https://opensource.org/licenses/GPL-3.0