Skip to content

Commit f9ea714

Browse files
committed
Update readme
1 parent 1518fdb commit f9ea714

File tree

1 file changed

+15
-26
lines changed

1 file changed

+15
-26
lines changed

README.md

Lines changed: 15 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,13 @@ For all available methods, see the [Helpers](src/Support/Helpers.php) class.
4242

4343
## Translation Service Provider
4444

45-
> Enhanced logging for missing translations and variables.
45+
> Logs missing translations and translation variables in the current language. Throws an exception when not in production environment. In debug mode, checks all available languages.
4646

47-
- **Missing Translation Logging**: Logs warnings when a translation key is missing.
48-
- **Missing Variables Logging**: Logs warnings when variables required in a translation string are not provided.
49-
- **All Locale Check**: In debug mode, it checks all available locales for missing translations and variables.
50-
- **TranslatorException**: Throws an `InternetGuru\LaravelCommon\Exceptions\TranslatorException` exception instead of logging when the app is not in production mode.
47+
- **Logs warning** when a translation key is missing or a variable required in a translation string is not provided.
48+
- **Checks all languages** in debug mode from all available locales.
49+
- **Throws exception** `InternetGuru\LaravelCommon\Exceptions\TranslatorException` instead of logging when the app is not in production mode.
5150

52-
Add the following lines to the `config/app.php` file to use the `TranslationServiceProvider`:
51+
To use the provider, add the following lines to the `config/app.php` file:
5352

5453
```php
5554
use Illuminate\Support\ServiceProvider;
@@ -77,21 +76,15 @@ class Task extends Model
7776
}
7877
```
7978

80-
## Blade Components
79+
## Breadcrumb Blade Component
8180

82-
> The package provides a set of Blade components for Laravel applications.
83-
84-
### Breadcrumb
85-
86-
> The Breadcrumb Blade component renders breadcrumb navigation in your application, helping users understand their location within the app's hierarchy.
81+
> Renders breadcrumb navigation based on routes matching the current URL segments. Supports translations with short and long labels, custom divider, and segment skipping.
8782
8883
Key Features:
8984

90-
- **Automatic Path Parsing**: Automatically parses the current URL and generates breadcrumb items based on your routes and translations.
91-
- **Customizable Divider**: Allows customization of the divider symbol between breadcrumb items.
92-
- **Localization Support**: Supports translation of breadcrumb items using Laravel's localization system.
93-
- **Short and Long Labels**: Supports both short and long labels for breadcrumb items.
94-
- **Segment Skipping**: Optionally skip a specified number of URL segments, useful for nested routes or prefixes.
85+
- **Customizable Divider** – Allows a custom divider symbol between breadcrumb items.
86+
- **Short and Long Labels** – Using `trans_choice` if available shows n-th right translation based on the item positon.
87+
- **Segment Skipping** – Skips a specified number of URL segments. Useful for nested routes or routes with prefixes (e.g. language).
9588

9689
Usage:
9790

@@ -143,23 +136,23 @@ Example:
143136
Long Application Name
144137
```
145138

146-
### System Messages
139+
## System Messages Blade Component
147140

148-
> The `messages` Blade component renders system success messages and error messages.
141+
> Renders system temporary success messages and persistent error messages in different colors, with a close button.
149142

150143
Include the component in your Blade template where you want the system messages to appear:
151144

152145
```html
153146
<x-ig::system-messages />
154147
```
155148

156-
### Form Inputs
149+
## Form Blade Components
157150

158-
> The package provides a set of Blade components for form inputs.
151+
> The package provides a set of Blade components for form and various inputs.
159152
160153
Notes:
161154

162-
- Google Recaptcha V3 is enabled by default. To disable it, set the `recaptcha` attribute to `false`.
155+
- The [Google Recaptcha V3](https://developers.google.com/recaptcha/docs/v3) service is enabled by default. To disable it, set the `recaptcha` attribute to `false`.
163156
- You need to install the [internetguru/laravel-recaptchav3](https://github.com/internetguru/laravel-recaptchav3) package for the Recaptcha to work.
164157

165158
Complete example:
@@ -190,10 +183,6 @@ To run the tests, use the following command:
190183

191184
This package uses [Orchestra Testbench](https://github.com/orchestral/testbench) to bootstrap a minimal Laravel environment for testing.
192185

193-
## Changelog
194-
195-
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
196-
197186
## License
198187

199188
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

0 commit comments

Comments
 (0)