chore: update README.md with detailed features and introduction

Author: iamspydey

.gitignore

@@ -27,4 +27,5 @@ yarn-error.log
 /.vscode
 /.zed
 
-/tmp
+/tmp
+BRAINSTORM.md

README.md

@@ -1,25 +1,132 @@
 # Laravel + React Starter Kit
 
-## Introduction
+## [Devs Buddy](https://devsbuddy.com) provides a highly opinionated Laravel Starter Kit with Inertia and React. It helps you get up and running quickly with clean, consistent, and fully type-safe code.
 
-Our React starter kit provides a robust, modern starting point for building Laravel applications with a React frontend using [Inertia](https://inertiajs.com).
+## 🧩 Introduction
 
-Inertia allows you to build modern, single-page React applications using classic server-side routing and controllers. This lets you enjoy the frontend power of React combined with the incredible backend productivity of Laravel and lightning-fast Vite compilation.
+This starter kit is a fork of [laravel's official react starter kit](https://github.com/laravel/react-starter-kit).
 
-This React starter kit utilizes React 19, TypeScript, Tailwind, and the [shadcn/ui](https://ui.shadcn.com) and [radix-ui](https://www.radix-ui.com) component libraries.
+It has been modified to be fully strict, with 100% type safety, and follows an action-oriented pattern.
 
-## Official Documentation
+A few more helpful default features have been added, and the built-in authentication system has been updated to follow these strict rules.
+This ensures consistent code quality across your entire project.
 
-Documentation for all Laravel starter kits can be found on the [Laravel website](https://laravel.com/docs/starter-kits).
+---
 
-## Contributing
+## 🌟 Inspirations
 
-Thank you for considering contributing to our starter kit! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
+- [nunomaduro/laravel-starter-kit-inertia-react](https://github.com/nunomaduro/laravel-starter-kit-inertia-react)
+- [nunomaduro/laravel-starter-kit](https://github.com/nunomaduro/laravel-starter-kit)
 
-## Code of Conduct
+## These projects were the main inspiration for creating this starter kit. I’ve added additional features that are essential for most modern applications.
 
-In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
+## 🚀 Highlights
 
-## License
+1. **Fully Strict Types**: It follows 100% of type coverage for all the classes, methods and logic.
+2. **Action Oriented Pattern**: It uses dedicated Action classes for handling business logic and mutations. This keeps your controllers clean and makes actions reusable across your project.
+3. **Cruddy by Design**: It embraces the Cruddy by Design pattern to stay aligned with Laravel’s core concepts, making everything easy to understand and extend.
 
-The Laravel + React starter kit is open-sourced software licensed under the MIT license.
+---
+
+## ⚙️ Default features
+
+1. **Authentication**: Based on Laravel’s built-in authentication, with a few tweaks to fit this project’s structure and standards.
+2. **Global Configs**: Most apps need some kind of global configuration that can be managed from one place and applied across the app. Includes settings like:
+    - App Logo
+    - App Favicon
+    - Basic Mail Config (excluding mail server credentials)
+3. **Mail Templates**: Includes a dynamic mail template system with a flexible Mailable class.
+   You can create templates with fields like Subject and Content, then send emails by simply calling helper methods with the template code — it just works.
+4. **Queuable Mail**: The mailing system combines the global config and mail template features.
+   If mail queueing is enabled in the config, emails will automatically be pushed to the queue for asynchronous delivery.
+5. **Events**: From the beggining this starter kit includes some events that are being fired on each action that may some other action in future, for this I follow to create Event for each action taken in the app, this way in future you just add a listener to listen these events and act upon them.
+    - Why custom events instead of model observers?
+
+        I prefer explicit event handling over “magic” behavior. With custom events, you can keep logic clean and encapsulated inside dedicated listener classes.
+
+6. **Custom Helpers**: Instead of a typical `helpers.php` file, this kit organizes helpers as **Traits**, **Services**, **Support** classes, and **Facades**.
+    - A small `helpers.php` file is still included for global functions where class imports aren’t possible.
+
+---
+
+## 🧰 Getting Started
+
+### 1. Requirements
+
+Make sure you have the following installed:
+
+- PHP 8.4+
+- Composer
+- Node.js & npm (or yarn/pnpm)
+
+### 2. Installation
+
+Clone the repository and install dependencies:
+
+```bash
+git clone https://github.com/devsbuddy/laravel-react-starter-kit.git your-awesome-app
+```
+
+### Setup
+
+Navigate to newly created prject directory and run setup commands
+
+```bash
+cd your-awesome-app # Navigate to the project directory
+
+composer setup # Install all deps and setup project
+```
+
+### Configure
+
+By default this starter kit uses sqlite database and if you want to use other database driver you can configure that in your `.env` file:
+
+```bash
+# Example PostgreSQL Config
+
+DB_CONNECTION=pgsql
+DB_HOST=127.0.0.1
+DB_PORT=5432
+DB_DATABASE=your_awesome_app
+DB_USERNAME=postgres
+DB_PASSWORD=
+```
+
+After configuring new database you can run migration and seeders:
+
+```bash
+php artisan migrate --seed
+
+# OR
+
+php artisan migrate:fresh --seed
+```
+
+### Start development server
+
+Now as the app is all setup correctly you can start working on it:
+
+```bash
+# Start development server
+composer dev
+```
+
+### Check on browser
+
+After running your development server you can visit to [http://localhost:8000](http://localhost:8000) or [http://127.0.0.1:8000](http://127.0.0.1:8000) on your favorite browser to see the app in action.
+
+🤝 Contributing
+
+Contributions are welcome!
+If you’d like to improve this starter kit, feel free to:
+
+1. Fork the repository
+2. Create a new feature branch (`git checkout -b feature/your-feature`)
+3. Commit your changes (`git commit -m 'Add some feature'`)
+4. Push to the branch (`git push origin feature/your-feature`)
+5. Open a Pull Request
+
+Please make sure your code follows the existing structure and style conventions also all tests are passing.
+
+📄 License
+This project is open-source and available under the MIT License.