aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..488d217
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# Lichess Game Notification
+
+### How to use it ?
+
+ 1. Install [Berserk](https://github.com/rhgrant10/berserk) with `pip install berserk`
+ 2. Generate an access token on [Lichess.org](https://lichess.org)
+ 3. Set the value of **ACCESS_TOKEN** variable in *notify.py* to the one use in step 2
+ 4. Now each time you want to check for notification simply run **./notify.py** (use crontab maybe)
+### Dependencies
+- `notify-send` This command should be available!
+- `berserk` The lichess python API