diff --git a/README.md b/README.md index f053565..98e1023 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ Rendering strings provided by users can result in unexpected typographic results. For instance, in most latin languages (such as french) it is recommended to add a non-breakable space in front of, amongst others, exclamation or question marks (`!` and `?`). Most users will probably just type a regular space, which could result in an unwanted line break just before these punctuation marks. -This simple package provides a `typography` macro to Laravel's `Str` facade and `Stringable` instances (created using `Str::of()` or `str()`) that will take care of these typographic details. +This simple package provides a `typography` macro for Laravel's `Str` facade and `Stringable` instances (created using `Str::of()` or `str()`) that will take care of these typographic details. -It is also possible to enhance the package by adding your own typographic rules. +It is also possible to enhance this package by adding your own typographic rules. ```php $content = 'Mama mia !'; @@ -23,25 +23,29 @@ composer require whitecube/laravel-string-typography ## Getting started -The package's ServiceProvider and therefore its `typography` macro will automatically be registered upon installation so you can start using it right away: +The package's ServiceProvider and therefore its `typography` macro will automatically be registered upon installation. You can start using it right away: ```blade - +{{-- Using the "Str" facade --}}
{!! str($paragraph)->typography() !!}
``` -Using `Stringable` instances, you can chain the `typography` method with other helpers: +Using `Stringable` instances, you can chain `typography` with other helper methods: ```blade