diff --git a/README.md b/README.md index e4fdd86b..700efe6b 100644 --- a/README.md +++ b/README.md @@ -49,15 +49,16 @@ Option | Description `router` | The router to use, when processing the route files (can be Laravel or Dingo - defaults to Laravel) `bindings` | List of route bindings that should be replaced when trying to retrieve route results. Syntax format: `binding_one,id|binding_two,id` -## Publish rule descriptions for customisation or translate. +## Publish rule descriptions for customisation or translation. - For default, this package returns the descriptions in the main language of the application. But provides the possibility of publish the language files for customisation or translate. + By default, this package returns the descriptions in the main language of the application. + You can publish the packages language files, to customise and translate the documentation output. ```sh $ php artisan vendor:publish ``` - After to publish you can customize or translate the descriptions in the language you want by editing the files in `public/vendor/apidoc/resources/lang`. + After the files are published you can customise or translate the descriptions in the language you want by editing the files in `public/vendor/apidoc/resources/lang`. ### How does it work?