diff --git a/README.md b/README.md index a506fd6..8fff6f1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # 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-cli is a TUI to play Bingo, built using [Textual](https://textual.textualize.io/). + ![bingo screenshot](img/bingo.png) ## Features @@ -21,3 +22,19 @@ pip install -r requirements.txt python3 bingo.py ``` +### Serve as a webpage + +- Install requirements as above. +- Download the latest build of `ttyd`: https://github.com/tsl0922/ttyd/releases +``` +chmod +x ttyd +# if not already in venv: +source venv/bin/activate +./ttyd -W ./bingo.py +``` +- Bingo is now served on `http://localhost:7681`. +- Check `ttyd --help` for more options and consider building a reverse proxy and `systemd` service. + +### Serve via SSH + +TBA