aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..486fff7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Daily Chess Puzzle
+
+Solve today's Lichess puzzle in your terminal.
+
+Python script `dailypuzzle.py` runs as a systemd service, fetches the FEN sequence and solution from Lichess' API which an endpoint /api/dailypuzzle on my website serves.
+
+## Usage
+`curl -sL chess.aryanmustafa.com/play | bash`
+
+## Requirements
+1. curl
+2. bash
+3. python3