From c517ff3c20fa1e19f19bc0767f76c9d936a7e4c3 Mon Sep 17 00:00:00 2001 From: Dorian Zedler Date: Thu, 5 Jan 2023 19:46:36 +0100 Subject: [PATCH] Docs: update readme --- README.md | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 928fd70..f1c0b5c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,27 @@ -# whose-turn-is-it +

+ Whose turn is it? +

-Simple webapp for playing games. \ No newline at end of file +

+ + + +

+ +Simple webapp to keep track of who is currently playing and how much time they have left. Originally designed for [Rummikub](https://de.wikipedia.org/wiki/Rummikub). +Please note: this is by no means perfect and just meant to be a simple solution to a simple problem :) + +# Featues +- Create an independent room +- Play with multiple players across multiple devices +- Decentralized +- End-to-end encrypted + +# How it works +The browsers of all players connect to a common MQTT server and communicate through that server. An AES Key is derived from the room name, which is then used to encrypt all communication. + +# Technologies +- [MQTT.js](https://github.com/mqttjs/MQTT.js) +- [Alpine.js](https://alpinejs.dev/) +- [Pico.css](https://picocss.com/) +- [crypto-js](https://github.com/brix/crypto-js) \ No newline at end of file