Add a simple readme

This commit is contained in:
Jared Miller 2026-02-23 17:16:02 -05:00
parent 00229f2b8e
commit 912bb2eb49
Signed by: shmup
GPG key ID: 22B5C6D66A38B06C

28
README.txt Normal file
View file

@ -0,0 +1,28 @@
slay with friends
=================
multiplayer browser version of slay the spire, played with friends.
based on the slay the spire board game rules from contention games.
video game card art for visuals, board game mechanics for gameplay.
1-4 players cooperate through map rooms, building decks and fighting
enemies. if any player hits 0 HP, everyone loses.
status: early development. building the core combat engine.
setup
-----
requires bun (https://bun.sh)
bun install
bun run dev
open http://localhost:3000
development
-----------
bun test run tests
bun run check lint + format + tests