From 2135de9d1d6018da3359e82a67e49f7aa1b3b561 Mon Sep 17 00:00:00 2001
From: Matthew Rice <101439807+Rice-Tech@users.noreply.github.com>
Date: Thu, 8 Feb 2024 21:16:00 -0500
Subject: [PATCH] Update README.md

Updated readme for post game jam
---
 README.md | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3911386..7552247 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,13 @@
-# Game Jam 2024 Project
+# Tumblewords
+Tumblewords is a party game inspired by classroom games like Kahoot and Madlibs. Players can host a game or join a game hosted by a friend using the link, id, or QR code and then collect words by hitting them with a ping pong ball. After players submit their words, the host's device reveals a story with the player-gathered words entered in! Tumblewords was developed for the Global Game Jam 2024.
+
+## Tech Stack
+Tumblewords uses React with Typescript on the front-end and Firebase's Firestore for the database. Shadcn and Tailwind CSS provide the UI and styling. The word collection game uses React Three Fiber and Rapier Physics along with several helpful drei componants from the excellent Poimandres group.
 
 ## How to Install and Develop locally
+Please follow these instructions to code locally (these were written for teammates during the game jam)
+Anyone who would like to develop their own version of this program will need to create a Firebase project and add its config information as GitHub secrets.
+
 ### Requirements
  - [Node.js] (https://nodejs.org/en)
  - A code editor like [VS Code] (https://code.visualstudio.com/)