Merge pull request #13 from Psypher1/readme-dante

Issue #5 | adds relevant information to readme

Author: VoidedName

README.md

@@ -1,34 +1,79 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# Code Racer
+
+Welcome to Code Racer, a community project built with Next.js, Tailwind CSS, and TypeScript.
+
+Code Racer is a multiplayer coding game where developers can compete against each other to solve programming challenges in real-time. Sharpen your coding skills, challenge your peers, and have fun while racing against the clock!
+
+## Features
+
+- Code snippet games
+
+## Technologies Used
+
+- Next.js: A React framework for building server-side rendered and statically generated applications.
+- NextAuth: For user authentication.
+- Prisma:
+- Tailwind CSS: A utility-first CSS framework for rapid UI development.
+- TypeScript: A typed superset of JavaScript that provides enhanced tooling and developer productivity.
 
 ## Getting Started
 
-First, run the development server:
+To get started with Code Racer locally, follow these steps:
+
+    Clone the repository:
+
+```bash
+git clone https://github.com/webdevcody/code-racer.git
+```
+
+Navigate to the project directory:
 
 ```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
+cd code-racer
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+Install dependencies:
+
+```bash
+npm install
+```
+
+Start the development server:
+
+```bash
+    npm run dev
+```
+
+Open your browser and visit http://localhost:3000 to see the application running.
+
+## Configuration
+
+Code Racer requires some configuration variables to run properly. Create a .env.local file in the root directory of the project and add the following variables:
+
+## Contribution
+
+We welcome contributions from the community! If you'd like to contribute to Code Racer, please follow refer to [CONTRIBUTION.md](CONTRIBUTION.md), but we have these base guidelines:
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+- Fork the repository.
+- Create a new branch for your feature or bug fix.
+- Make your changes and test thoroughly.
+- Commit your changes with clear commit messages.
+- Push your branch to your forked repository.
+  Submit a pull request detailing your changes.
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+Please ensure that your code adheres to the project's coding standards and conventions.
 
-## Learn More
+## License
 
-To learn more about Next.js, take a look at the following resources:
+The Code Racer project is licensed under the MIT License. Feel free to use, modify, and distribute the code as per the terms of the license.
+Acknowledgements
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+Code Racer wouldn't be possible without the valuable contributions and support from the open-source community. We would like to express our gratitude to all the contributors and acknowledge the following libraries and resources used in this project.
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+A big thank you to all the developers who have helped shape Code Racer into what it is today!
 
-## Deploy on Vercel
+## Contact
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+If you have any questions, suggestions, or feedback regarding Code Racer, please feel free to reach out to us at in the WebDevCody discord server
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+Happy coding and enjoy the race!