summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 6 insertions, 14 deletions
diff --git a/README.md b/README.md
index dcc6ca75..ad9a6d38 100644
--- a/README.md
+++ b/README.md
@@ -45,13 +45,11 @@ Before you begin, ensure you have the following installed on your system:
### Setup
-## Getting Started
-
1. Fork the repository
2. Clone your fork locally
3. Navigate to the web app directory: `cd apps/web`
4. Install dependencies: `bun install`
-5. Start the development server: `bun run dev`
+5. Start the development server: `bun dev`
## Development Setup
@@ -124,14 +122,6 @@ Before you begin, ensure you have the following installed on your system:
# Or use an online generator: https://generate-secret.vercel.app/32
```
- **Optional Variables (for Google OAuth):**
-
- ```bash
- # Only needed if you want to test Google login
- GOOGLE_CLIENT_ID="your-google-client-id"
- GOOGLE_CLIENT_SECRET="your-google-client-secret"
- ```
-
5. Run database migrations: `bun run db:migrate` from (inside apps/web)
6. Start the development server: `bun run dev` from (inside apps/web)
@@ -139,11 +129,13 @@ The application will be available at [http://localhost:3000](http://localhost:30
## Contributing
-**Note**: We're currently moving at an extremely fast pace with rapid development and breaking changes. While we appreciate the interest, it's recommended to wait until the project stabilizes before contributing to avoid conflicts and wasted effort.
+We welcome contributions! While we're actively developing and refactoring certain areas, there are plenty of opportunities to contribute effectively.
+
+**🎯 Focus areas:** Timeline functionality, project management, performance, bug fixes, and UI improvements outside the preview panel.
-## Visit [CONTRIBUTING.md](.github/CONTRIBUTING.md)
+**⚠️ Avoid for now:** Preview panel enhancements (fonts, stickers, effects) and export functionality - we're refactoring these with a new binary rendering approach.
-We welcome contributions! Please see our [Contributing Guide](.github/CONTRIBUTING.md) for detailed setup instructions and development guidelines.
+See our [Contributing Guide](.github/CONTRIBUTING.md) for detailed setup instructions, development guidelines, and complete focus area guidance.
**Quick start for contributors:**