docs: replace skeleton readme with project readme

Author: dnlblasco

README.md

@@ -1,46 +1,117 @@
-<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>
+<p align="center">
+  <img src="docs/assets/bluemenu-logo.png" alt="BlueMenu Web Editor" width="760">
+</p>
+
+<p align="center">
+  <strong>Browser based editor for BlueMenu menus, served at <a href="https://menu.blueva.net">menu.blueva.net</a>.</strong>
+</p>
 
 <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>
+  <img alt="Laravel" src="https://img.shields.io/badge/Laravel-13-FF2D20?logo=laravel&logoColor=white">
+  <img alt="PHP" src="https://img.shields.io/badge/PHP-8.3+-777BB4?logo=php&logoColor=white">
+  <img alt="React" src="https://img.shields.io/badge/React-19-61DAFB?logo=react&logoColor=black">
+  <img alt="TypeScript" src="https://img.shields.io/badge/TypeScript-7-3178C6?logo=typescript&logoColor=white">
+  <img alt="Vite" src="https://img.shields.io/badge/Vite-8-646CFF?logo=vite&logoColor=white">
+  <img alt="Tailwind" src="https://img.shields.io/badge/Tailwind-4-06B6D4?logo=tailwindcss&logoColor=white">
+  <img alt="License" src="https://img.shields.io/badge/license-GPL--3.0-green">
 </p>
 
-## About Laravel
+## Overview
+
+This is the web frontend behind `/bm editor` in [BlueMenu](https://github.com/BluevaDevelopment/BlueMenu). Server owners edit their Java chest menus and their Bedrock forms from the browser instead of hand writing YAML, and the plugin applies the result on the live server.
+
+The plugin is the source of truth. Menu files stay under `plugins/BlueMenu/menus/`, and the editor talks to the server over a WebSocket connection, so nothing is copied into a separate account or database that could drift from what the server actually loads.
+
+## How a session works
+
+1. A player runs `/bm editor` in game. The plugin opens a session against `wss://menu.blueva.net/ws` and hands the player a link.
+2. Opening the link binds that browser window to the session. Each window carries its own verification id, so a leaked link does not grant access on its own.
+3. If `require-confirmation` is on in `settings.yml`, the plugin waits for `/bm confirm` in game before the session becomes editable.
+4. The editor requests the menu list, loads a menu, and saves changes back through the same socket. With `auto-save` and `auto-reload` enabled, the plugin writes the YAML and reloads the menu immediately.
+
+Sessions expire on their own, and the plugin rejects any message whose session is unknown, consumed or unconfirmed.
+
+## Stack
+
+- Laravel 13 on PHP 8.3+
+- React 19 with TypeScript 7, mounted from a Blade shell
+- Vite 8 with the Laravel plugin, Tailwind 4 and Bunny Fonts
+- SQLite by default, MySQL in production
+- PHPUnit for tests
+
+## Project Layout
+
+```
+app/
+├── Http/Controllers/   HTTP entry points
+├── Models/             Eloquent models
+└── Providers/          service providers
+resources/
+├── css/app.css         Tailwind entry
+├── js/                 React application, entry at app.tsx
+└── views/              Blade shell that mounts React
+routes/web.php          web routes
+database/migrations/    schema
+tests/                  PHPUnit feature and unit tests
+```
+
+## Requirements
+
+| Component | Version |
+|---|---|
+| PHP | 8.3+ |
+| Composer | 2+ |
+| Node | 20+ |
+| Database | SQLite for local work, MySQL 8+ in production |
+
+## Getting Started
+
+```bash
+composer setup
+```
 
-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:
+That single command installs dependencies, creates `.env`, generates the app key, migrates and builds the assets. To run it by hand:
 
-- [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).
+```bash
+composer install
+cp .env.example .env
+php artisan key:generate
+php artisan migrate
+npm install
+npm run build
+```
 
-Laravel is accessible, powerful, and provides tools required for large, robust applications.
+Then start the dev server:
 
-## Learning Laravel
+```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.
+`composer dev` runs `php artisan dev`, which brings up the PHP server, the queue worker, the log tailer and Vite together. If a frontend change does not show up, the Vite process is probably not running.
 
-In addition, [Laracasts](https://laracasts.com) 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.
+## Development
 
-You can also watch bite-sized lessons with real-world projects on [Laravel Learn](https://laravel.com/learn), where you will be guided through building a Laravel application from scratch while learning PHP fundamentals.
+```bash
+npm run dev          # Vite dev server with hot reload
+npm run typecheck    # tsc --noEmit
+npm run build        # production assets
+composer test        # clears config, then runs PHPUnit
+```
 
-## Contributing
+Run the narrowest test set that covers a change, for example `php artisan test --compact --filter=SomeTest`.
 
-Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
+## Deployment
 
-## Code of Conduct
+`.github/workflows/deploy.yml` typechecks, builds and runs the test suite on every push and pull request. On `main` it then pulls, installs production dependencies, rebuilds the assets, migrates and warms the caches on the host.
 
-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).
+## Authors
 
-## Security Vulnerabilities
+- Blueva
+- Whiron
+- Arthuurrr
 
-If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.
+Website: [blueva.net](https://blueva.net)
 
 ## License
 
-The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
+Licensed under the [GNU General Public License v3.0](LICENSE).