From b33c304ffbd8913a53925f4feeaa2418574bd449 Mon Sep 17 00:00:00 2001 From: Maximilian Liebmann Date: Fri, 9 May 2025 22:46:02 +0200 Subject: [PATCH] docs: update README.md with detailed project description, features, and setup instructions Adds a detailed project description, implemented and planned features, technologies used, and setup instructions to the README. --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9e1f4fe..1d4b270 100644 --- a/README.md +++ b/README.md @@ -94,10 +94,6 @@ This project is built with a modern tech stack: # Base URL of your application NEXT_PUBLIC_APP_URL="http://localhost:3000" - - # Development: Skip login flow (set to "true" to bypass authentication) - # Ensure this is NOT set to "true" in production. - MEETUP_SKIP_LOGIN="false" ``` 4. **Apply database migrations (Prisma):** @@ -122,6 +118,8 @@ This project is built with a modern tech stack: ## Contributing +_(This section can be expanded as your project grows and you're open to contributions.)_ + Contributions are welcome! If you'd like to contribute, please: 1. Fork the repository. @@ -133,6 +131,8 @@ Contributions are welcome! If you'd like to contribute, please: Please ensure your code adheres to the project's coding standards (e.g., run linters/formatters if configured) and that any database schema changes are accompanied by a Prisma migration. +_(Optional: You can add more details about reporting bugs, suggesting features, or coding style guides here.)_ + --- **(Optional Sections You Might Want to Add Later):**