44[ ![ License] ( https://img.shields.io/packagist/l/sindyko/aliaser.svg?style=flat-square )] ( https://packagist.org/packages/sindyko/aliaser )
55[ ![ Tests] ( https://github.com/sindyko/aliaser/actions/workflows/tests.yml/badge.svg )] ( https://github.com/sindyko/aliaser/actions/workflows/tests.yml )
66
7+ ## Requirements
8+
9+ - PHP ^8.1|^8.2|^8.3
10+ - Laravel ^10.0|^11.0|^12.0
11+ - Livewire ^3.0 (optional, for Livewire integration)
12+
713# Aliaser 🎭
814
915Elegant alias management for Laravel Eloquent models, Livewire forms, DTOs, collections, and enums. Replace long class
@@ -20,6 +26,24 @@ names with short, memorable aliases throughout your application and Livewire sna
2026- 🔒 ** Security** - obfuscated class paths in frontend
2127- 🧪 ** Fully tested** - comprehensive test coverage
2228
29+ ## Features
30+
31+ ### Core Features (work everywhere)
32+
33+ - 🎯 ** Entity Facade** - Access models by alias: ` Entity::user(1) ` instead of ` User::find(1) `
34+ - 🗺️ ** Morph Map Integration** - Automatically sync aliases with Eloquent morph map
35+ - 📦 ** Multiple Registries** - Separate registries for Models, Forms, DTOs, Collections, and Enums
36+ - 🛠️ ** Artisan Commands** - ` aliaser:install ` , ` aliaser:list ` , ` aliaser:help `
37+ - 🔧 ** Helper Functions** - Convenient ` modelsMap() ` , ` formsMap() ` , etc.
38+
39+ ### Livewire 3.x Features
40+
41+ - 🚀 ** Snapshot Optimization** - Up to 50% smaller Livewire snapshots
42+ - 🔒 ** Hide Internal Structure** - Short aliases instead of full class names in frontend
43+ - ⚡ ** Custom Synthesizers** - Automatic serialization for Models, Collections, Forms, Enums, and DTOs
44+
45+ > ** Note** : Livewire features require Livewire 3.x. See [ Livewire Compatibility] ( #livewire-compatibility ) for details.
46+
2347## 📦 Installation
2448
2549``` bash
@@ -787,5 +811,57 @@ The MIT License (MIT). Please see [License File](LICENSE.md) for more informatio
787811
788812***
789813
814+ ### Livewire Compatibility
815+
816+ ** Current Status:**
817+
818+ - ✅ ** Livewire 3.x** - Fully supported with all features
819+ - ⚠️ ** Livewire 2.x** - Not currently supported (coming soon)
820+ - ✅ ** No Livewire** - Core features work without Livewire
821+
822+ > ** Note** : Livewire 2.x support is planned for a future release. Currently, if you have Livewire 2.x installed,
823+ > Livewire-specific features (snapshot optimization) will be automatically disabled, but all other features will work
824+ > normally.
825+
826+ #### What works without Livewire 3?
827+
828+ Even without Livewire 3.x (or without Livewire at all), you can use:
829+
830+ - ✅ ** Entity facade** : ` Entity::user()->where('active', true)->get() `
831+ - ✅ ** Model morph map integration** : Short aliases in database polymorphic relations
832+ - ✅ ** All registries** : Models, Forms, Objects, Collections, Enums
833+ - ✅ ** Artisan commands** : ` aliaser:list ` , ` aliaser:help ` , etc.
834+
835+ Only ** Livewire snapshot optimization** requires Livewire 3.x.
836+
837+ #### Upgrading to Livewire 3
838+
839+ If you're using Livewire 2.x and want full Aliaser integration:
840+
841+ ***
842+
843+ ## FAQ
844+
845+ ### Does Aliaser work without Livewire?
846+
847+ Yes! Core features like Entity facade, morph map integration, and registries work perfectly without Livewire. Only
848+ snapshot optimization requires Livewire 3.x.
849+
850+ ### I have Livewire 2.x installed. Will Aliaser work?
851+
852+ Yes, but with limited functionality. Aliaser will automatically detect Livewire 2.x and disable Livewire-specific
853+ features. The Entity facade, registries, and morph map integration will work normally. Livewire 2.x support is planned
854+ for future releases.
855+
856+ ### Why doesn't Aliaser support Livewire 2.x yet?
857+
858+ Livewire 3 introduced a new synthesizer architecture that Aliaser uses for snapshot optimization. Livewire 2 has a
859+ different internal structure. We're working on backward compatibility and plan to support Livewire 2.x in an upcoming
860+ release.
861+
862+ ### How do I check which version of Livewire I have?
863+
864+ ***
865+
790866Made with ❤️ for the Laravel community
791867
0 commit comments