Replace Laravel boilerplate README with SweetAlert2 integration documentation (#8)

* Initial plan

* Replace boilerplate README with SweetAlert2-Laravel integration focused README

Co-authored-by: limonte <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: limonte <[email protected]>

Author: Copilot

README.md

@@ -1,59 +1,118 @@
-<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
+# SweetAlert2 + Laravel + Inertia React Demo
 
-<p align="center">
-<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
-</p>
+A simple demo application showing how to integrate [SweetAlert2](https://sweetalert2.github.io/) with Laravel and Inertia React using the [`sweetalert2/laravel`](https://github.com/sweetalert2/sweetalert2-laravel) package.
+
+## Features
 
-## About Laravel
+- 🎉 Beautiful alerts and toasts with SweetAlert2
+- ⚡ Seamless Laravel + Inertia React integration
+- 🔄 Server-side alert triggering with client-side display
+- 📦 Simple todo app demonstrating the integration
 
-Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
+## Installation
 
-- [Simple, fast routing engine](https://laravel.com/docs/routing).
-- [Powerful dependency injection container](https://laravel.com/docs/container).
-- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
-- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
-- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
-- [Robust background job processing](https://laravel.com/docs/queues).
-- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
+1. Clone the repository:
+```bash
+git clone https://github.com/sweetalert2/sweetalert2-laravel-inertia-react-demo.git
+cd sweetalert2-laravel-inertia-react-demo
+```
 
-Laravel is accessible, powerful, and provides tools required for large, robust applications.
+2. Install dependencies and set up the application:
+```bash
+composer setup
+```
 
-## Learning Laravel
+3. Run the development server:
+```bash
+composer dev
+```
 
-Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework. You can also check out [Laravel Learn](https://laravel.com/learn), where you will be guided through building a modern Laravel application.
+The application will be available at `http://localhost:8000`.
 
-If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
+## How It Works
 
-## Laravel Sponsors
+### 1. Include SweetAlert2 in Your Layout
 
-We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the [Laravel Partners program](https://partners.laravel.com).
+Add the SweetAlert2 template to your Blade layout (`resources/views/app.blade.php`):
 
-### Premium Partners
+```blade
+@include('sweetalert2::index')
+```
 
-- **[Vehikl](https://vehikl.com)**
-- **[Tighten Co.](https://tighten.co)**
-- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
-- **[64 Robots](https://64robots.com)**
-- **[Curotec](https://www.curotec.com/services/technologies/laravel)**
-- **[DevSquad](https://devsquad.com/hire-laravel-developers)**
-- **[Redberry](https://redberry.international/laravel-development)**
-- **[Active Logic](https://activelogic.com)**
+### 2. Configure Inertia Middleware
 
-## Contributing
+Share the SweetAlert2 session data in `HandleInertiaRequests.php`:
 
-Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
+```php
+use SweetAlert2\Laravel\Swal;
 
-## Code of Conduct
+public function share(Request $request): array
+{
+    return array_merge(parent::share($request), [
+        'flash' => [
+            Swal::SESSION_KEY => fn () => $request->session()->pull(Swal::SESSION_KEY),
+        ],
+    ]);
+}
+```
 
-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).
+### 3. Trigger Alerts from Laravel
 
-## Security Vulnerabilities
+Use the `Swal` facade anywhere in your Laravel controllers or routes:
 
-If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.
+```php
+use SweetAlert2\Laravel\Swal;
+
+// Show a success toast after saving
+Swal::toastSuccess([
+    'title' => 'Saved!',
+    'position' => 'top-end',
+    'showConfirmButton' => false,
+    'timer' => 3000,
+    'timerProgressBar' => true,
+]);
+
+return redirect('/');
+```
+
+### Available Methods
+
+```php
+// Alerts with icons
+Swal::success(['title' => 'Success!']);
+Swal::error(['title' => 'Error!']);
+Swal::warning(['title' => 'Warning!']);
+Swal::info(['title' => 'Info!']);
+Swal::question(['title' => 'Question?']);
+
+// Toast notifications
+Swal::toast(['title' => 'Toast']);
+Swal::toastSuccess(['title' => 'Success!']);
+Swal::toastError(['title' => 'Error!']);
+Swal::toastWarning(['title' => 'Warning!']);
+Swal::toastInfo(['title' => 'Info!']);
+Swal::toastQuestion(['title' => 'Question?']);
+
+// Full configuration
+Swal::fire([
+    'title' => 'Custom Alert',
+    'text' => 'With custom options',
+    'icon' => 'success',
+    'confirmButtonText' => 'OK',
+    // ...any SweetAlert2 option
+]);
+```
+
+See the [SweetAlert2 documentation](https://sweetalert2.github.io/#configuration) for all available options.
+
+## Tech Stack
+
+- Laravel 12
+- Inertia.js 2
+- React 19
+- Tailwind CSS 4
+- SweetAlert2
 
 ## License
 
-The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
+MIT