From 0b35f4e55eb2255176d28a4d2a028818b4b9d843 Mon Sep 17 00:00:00 2001 From: Alan Moon Date: Sun, 27 Jul 2025 16:57:46 -0700 Subject: [PATCH] Update README.md --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0591feb..de087e0 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,9 @@ This is a from scratch SignalR based chat server that has the following features - Profiles - Currency - Stock Market +- Multiplayer Tic-Tac-Toe +- Email Verification +- Profile Cosmetics Store # How To Build In order to build, you need the .NET 9 SDK. @@ -16,9 +19,15 @@ In order to build, you need the .NET 9 SDK. 3. Configure And Enjoy! # Docker Container (Recommended Self-Hosting Solution) -This Server Does Have A Docker Container You Can Create That Contains Your Config And User Content. Please Refer To ``docker-compose.yml`` +This Server Does Have A Docker Container You Can Create That Contains Your Config And User Content. Please Refer To `docker-compose.yml` # JWT Keys -JWT Keys should be generated from scatch and added to your ``docker-compose.yml`` environment variables. +JWT Keys should be generated from scatch and added to your `docker-compose.yml` environment variables. -Anything Can Be Put Here, But For Security, It Should Be Within 32-Characters Long And Should Be Secure. An Example Key Is Provided, And Should Not Be Used In Production. \ No newline at end of file +Anything Can Be Put Here, But For Security, It Should Be Within 32-Characters Long And Should Be Secure. An Example Key Is Provided, And Should Not Be Used In Production. + +# .env File +The environment variable file is used to store sensitive info and settings, such as db passwords, keys, etc. +Most things are configured here, however some things are configured in `appsettings.json` + +Please refer to `.env.sample` for more info. \ No newline at end of file