3.x Set default locale via Middleware

README.md

@@ -8,6 +8,11 @@
 
 Easy i18n localization for Laravel, an useful tool to combine with Laravel localization classes.
 
+This documentation covers version 3.x, compatible exclusively with Laravel 9 and later.
+We strongly recommend using this version, as it resolves numerous compatibility issues present in versions 1.x and 2.x, 
+and seamlessly integrates with Laravel's default caching. 
+If you need to use an older version, please switch to `legacy` branch by clicking [here](https://github.com/mcamara/laravel-localization/tree/legacy).
+
 The package offers the following:
 
  - Detect language from browser
@@ -35,25 +40,18 @@ The package offers the following:
 - <a href="#changelog">Changelog</a>
 - <a href="#license">License</a>
 
-## Laravel compatibility
+## Laravel Compatibility
+
+| Laravel Version | laravel-localization Version | PHP Requirement         |
+|------------------|-----------------------------|--------------------------|
+| 9.x - 11.x       | 3.x                         | PHP >= 8.2               |
 
- Laravel      | laravel-localization
-:-------------|:----------
- 4.0.x        | 0.13.x
- 4.1.x        | 0.13.x
- 4.2.x        | 0.15.x
- 5.0.x/5.1.x  | 1.0.x
- 5.2.x-5.4.x (PHP 7 not required)  | 1.2.
- 5.2.0-6.x (PHP version >= 7 required) | 1.4.x
- 6.x-10.x (PHP version >= 7 required) | 1.8.x
- 10.x-11.x (PHP version >= 8.2 required) | 2.0.x
+For older versions (0.x to 2.x) switch to `legacy` branch by clicking [here](https://github.com/mcamara/laravel-localization/tree/legacy).
 
 ## Installation
 
 Install the package via composer: `composer require mcamara/laravel-localization`
 
-For Laravel 5.4 and below it necessary to [register the service provider](/ADDITIONS.md#for-laravel-5.4-and-below).
-
 ### Config Files
 
 In order to edit the default configuration you may execute:
@@ -74,6 +72,8 @@ The configuration options are:
  - **utf8suffix** Allow changing utf8suffix for CentOS etc.
  - **urlsIgnored** Ignore specific urls.
 
+
+
 ### Register Middleware
 
 You may register the package middleware in the `app/Http/Kernel.php` file:
@@ -123,52 +123,65 @@ Add the following to your routes file:
 
 ```php
 // routes/web.php
+Route::localized(function () {
+    // put your routes here
+    // Example route..
+    Route::get('/', function()
+    {
+        return __('test.hi');
+	})->name('route_name_example_hi');
 
-Route::group(['prefix' => LaravelLocalization::setLocale()], function()
-{
-	/** ADD ALL LOCALIZED ROUTES INSIDE THIS GROUP **/
-	Route::get('/', function()
-	{
-		return View::make('hello');
-	});
-
-	Route::get('test',function(){
-		return View::make('test');
-	});
-});
+    Route::get('/test', function()
+    {
+        return __('test.color');
+	});   
+}, [\Mcamara\LaravelLocalization\Middleware\LocaleSetLanguage::class]);
+```
+All routes in this group are localized. The package sets your application locale `App::getLocale()` according to your url. The locale may then be used for [Laravel's localization features](http://laravel.com/docs/localization).
 
-/** OTHER PAGES THAT SHOULD NOT BE LOCALIZED **/
+### Example
 
-```
+Once you’ve added the localized group to your `routes/web.php` file, 
+your application supports all locales listed in the `supportedLocales` configuration (e.g., `en` and `es` by default).
 
-Once this route group is added to the routes file, a user can access all locales added into `supportedLocales` (`en` and `es` by default).
-For example, the above route file creates the following addresses:
+#### If `hideDefaultLocaleInURL` is set to `false`
 
+If `hideDefaultLocaleInURL` is set to `false`, routes are created **once**, using the `{locale}` placeholder in the URL.
+
+Command output from `php artisan route:list`
+
+```
+GET|HEAD       {locale} ............. route_name_example_hi
+GET|HEAD       {locale}/test ..............................
 ```
-// Set application language to English
-http://url-to-laravel/en
-http://url-to-laravel/en/test
 
-// Set application language to Spanish
-http://url-to-laravel/es
-http://url-to-laravel/es/test
+For example, if `en` and `es` are configured as ``supportedLocales`, you can access these URLs:
 
-// Set application language to English or Spanish (depending on browsers default locales)
-// if nothing found set to default locale
-http://url-to-laravel
-http://url-to-laravel/test
 ```
-The package sets your application locale `App::getLocale()` according to your url. The locale may then be used for [Laravel's localization features](http://laravel.com/docs/localization).
+// English (locale: 'en')
+localhost/en
+localhost/en/test
 
-You may add middleware to your group like this:
+// Spanish (locale: 'es')
+localhost/es
+localhost/es/test
+``` 
 
-```php
-Route::group(
-[
-	'prefix' => LaravelLocalization::setLocale(),
-	'middleware' => [ 'localeSessionRedirect', 'localizationRedirect', 'localeViewPath' ]
-], function(){ //...
-});
+#### If `hideDefaultLocaleInURL` is set to `true`
+If `hideDefaultLocaleInURL` is set to `true`, each route defined in the `localized` group is created **twice**:
+
+1. **With `{locale}` placeholder**: Allows URLs like `/en` or `/es`.
+2. **Without any prefix**: These routes serve as fallback routes for the default locale.
+
+Routes without a locale prefix are automatically named with the `default_lang.` prefix.
+
+Command output from `php artisan route:list`
+
+```
+GET|HEAD       / ....... default_lang.route_name_example_hi
+GET|HEAD       test ......................... default_lang.
+GET|HEAD       {locale} ............. route_name_example_hi
+GET|HEAD       {locale}/test ..............................
 ```
 
 ### Recommendations