refresh readme

readme.md

@@ -1,7 +1,7 @@
 Laravel Extension
 =================
 
-Includes a set of extensions to the Laravel Framework 5.4+
+Includes a set of uselful extensions to the Laravel Framework.
 
 * [Installation](#installation)
 * [Helpers](#helpers)
@@ -20,50 +20,116 @@ composer require axn/laravel-extension
 Helpers
 -------
 
-In addition to Laravel helpers:
+### carbon()
 
-- `carbon()`: Create a Carbon instance from a date string, a DateTime instance or a timestamp
-- `collect_models()`: Create a collection of Eloquent models
-- `str_html()`: Create an Illuminate\Support\HtmlString instance
-- `linebreaks()`: Convert all line-endings to UNIX format
-- `nl_to_p()`: Convert new lines into paragraphs
-- `nl_to_br()`: Alias of native PHP function nl2br()
-- `number_formated()`: Returns a number in current language format
-- `number_fr()`: Returns a number in french format
-- `compute_dec_to_time()`: Decimal to time calculation (returns an array with hours, minutes and seconds)
-- `convert_dec_to_time()`: Decimal to time conversion (format: HH:MM:SS)
-- `human_readable_bytes_size()`: Convert a bytes size into a human readable size
-- `mime_type_to_fa5_class()`: Return a font awesome file icon class for specific MIME Type
-- `trans_ucfirst()`: Translate the given message with first character uppercase
-- `is_valid_model()`: Indicates whether the model class is instantiable and is an instance of Illuminate\Database\Eloquent\Model
+Create a Carbon instance from a date string, a DateTime instance or a timestamp.
+
+### collect_models()
+
+Create a collection of Eloquent models.
+
+### str_html()
+
+Create an `Illuminate\Support\HtmlString` instance.
+
+### linebreaks()
+
+Convert all line-endings to UNIX format.
+
+### nl_to_p()
+
+Convert new lines into paragraphs.
+
+### nl_to_br()
+
+Alias of native PHP function `nl2br()`.
+
+### number_formated()
+
+Returns a number in current language format.
+
+### number_fr()
+
+Returns a number in french format.
+
+### compute_dec_to_time()
+
+Decimal to time calculation (returns an array with hours, minutes and seconds).
+
+### convert_dec_to_time()
+
+Decimal to time conversion (format: HH:MM:SS).
+
+### human_readable_bytes_size()
+
+Convert a bytes size into a human readable size.
+
+### mime_type_to_fa5_class()
+
+Return a font awesome file icon class for specific MIME Type.
+
+### trans_ucfirst()
+
+Translate the given message with first character uppercase.
+
+### is_valid_model()
+
+Indicates whether the model class is instantiable and is an instance of `Illuminate\Database\Eloquent\Model`.
 
 
 Blade directives
 ----------------
 
-In addition to Laravel Blade directives:
+### @hassection('section-name')
 
-- `@hassection('section-name')`: Indicates if a section exists ; **deprecated 7.5.2** will be removed in 8.0.0 Use native `@hasSection` instead
-- `@doesnthavesection('section-name')`: Indicates if a section does not exist ; **deprecated 7.5.2** will be removed in 8.0.0 Use native `@sectionMissing` instead
-- `@nltop()`: Transform new lines into paragraphs `<p>`
-- `@nltobr()`: Transform new lines into `<br>`
+Indicates if a section exists.
+
+**Deprecated 7.5.2** will be removed in 8.0.0 Use native `@hasSection` instead.
 
 ```blade
 @hassection('section-a')
    // section "section-a" exists...
 @endhassection
+```
+
+### @doesnthavesection('section-name')
 
+Indicates if a section does not exist.
+
+**Deprecated 7.5.2** will be removed in 8.0.0 Use native `@sectionMissing` instead.
+
+```blade
 @doesnthavesection('section-b')
    // section "section-b" does not exist...
 @enddoesnthavesection
+```
+
+ ### @nltop()
+
+Transform new lines into paragraphs `<p>`
+
+```blade
+@nltop ("a text with \n new lines \n\n again \n\n\n and again")
+```
 
+Displays:
+
+```html
+<p>a text with <br> new lines </p><p> again </p><p> and again</p>
+```
 
-@nltop("a text with \n new lines \n\n again \n\n\n and again \n\n\n\n\n voilà")
-// <p>a text with <br> new lines </p><p> again </p><p> and again </p><p> voilà</p>
+### @nltobr()
+
+Transform new lines into `<br>`
+
+```blade
+@nltobr ("a text with \n new lines \n\n again \n\n\n and again")
+```
 
-@nltobr("a text with \n new lines \n\n again \n\n\n and again \n\n\n\n\n voilà")
-// a text with <br> new lines <br><br> again <br><br><br> and again <br><br><br><br><br> voilà
+Displays:
 
+```html
+a text with <br> new lines <br><br> again <br><br><br> and again
 ```
 
 HTML/Form macros
@@ -73,24 +139,43 @@ In addition to LaravelCollective HTML and Form methods:
 
 ```blade
 {!! Form::labelRequired('name', 'Label value') !!}
-//
-// Displays:
-//
-// <label for="name">Label value
-//      <span class="required">
-//          <i class="fa fa-asterisk"></i>
-//          <span class="sr-only">required</span>
-//      </span>
-// </label>
+```
 
+Displays:
+
+```html
+<label for="name">Label value
+   <span class="required">
+      &#x2a;
+      <span class="sr-only visually-hidden">required</span>
+   </span>
+</label>
+```
+
+```blade
 {!! Html::infoRequiredFields() !!}
-//
-// Displays:
-//
-// Fields marked with
-// <span class="required">
-//      <i class="fa fa-asterisk"></i>
-//      <span class="sr-only">required</span>
-// </span>
-// are mandatory.
 ```
+
+Displays:
+
+```html
+Fields marked with
+<span class="required">
+   &#x2a;
+   <span class="sr-only visually-hidden">required</span>
+</span>
+are mandatory.
+```
+
+```blade
+{!! Html::requiredMarker() !!}
+```
+
+Displays:
+
+```html
+<span class="required">
+   &#x2a;
+   <span class="sr-only visually-hidden">required</span>
+</span>
+```