From 70c47544d3c0052a114ca8f5337c9255b9d8a85b Mon Sep 17 00:00:00 2001
From: Felix Pankratz <mail@felixpankratz.de>
Date: Sun, 19 May 2024 15:43:39 +0200
Subject: [PATCH] add readme

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a506fd6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# bingo-cli - Play bingo in your terminal (or browser)
+
+bingo-cli is a TUI to play Bingo, built using [Textual](https://textual.textualize.io/).
+![bingo screenshot](img/bingo.png)
+
+## Features
+- Mouse and keyboard controls
+- Reproducible board states (by supplying UNIX timestamps)
+- Playable directly in your terminal, remotely via SSH or web browser
+
+## Installation
+
+### Install in python3 venv
+
+```
+python3 -m venv venv
+source venv/bin/activate
+pip install -r requirements.txt
+
+# test to see if it works:
+python3 bingo.py
+```
+