Update README.md

This commit is contained in:
Maciej Gomoła 2024-03-18 18:53:53 +01:00 committed by GitHub
parent dde5280c98
commit 1ab36bb32e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -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).