From 1ab36bb32e2d8f440e2916f780d6b0e72fbb1c67 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Maciej=20Gomo=C5=82a?= <me@maciejka.xyz>
Date: Mon, 18 Mar 2024 18:53:53 +0100
Subject: [PATCH] Update README.md

---
 README.md | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 3ab950b..208aa72 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,8 @@
-# statki-backend
-Backend do gry w statki
+# statki (battleships)
+The entire thing is not complete so expect vulnerabilities, missing features and more scary stuff 👻.
+
+Simple battleships game made in Express + vanilla DHTML (seriously).<br>
+It uses Redis as a store and Socket.io for websockets. All the operations like ship position validating, shot validating and rooms are made server-side.
+
+**Unfortunately the entire repo is in Polish**, I might add localisation in the future if I feel like it.<br>
+Also check out the `service-overhaul` branch that contains multiple service changes from the main branch (like accounts, e-mail auth code login, MySQL persistent match data saving and more in the future).