Skip to content

Commit a47359d

Browse files
committed
Update readme.md
1 parent 65818a1 commit a47359d

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Very short description of the package
1+
# Laravel trailing slash
22

33
[![Latest Version on Packagist](https://img.shields.io/packagist/v/gnahotelsolutions/laravel-trailing-slash.svg?style=flat-square)](https://packagist.org/packages/gnahotelsolutions/laravel-trailing-slash)
44
[![Build Status](https://img.shields.io/travis/gnahotelsolutions/laravel-trailing-slash/master.svg?style=flat-square)](https://travis-ci.org/gnahotelsolutions/laravel-trailing-slash)
55
[![Quality Score](https://img.shields.io/scrutinizer/g/gnahotelsolutions/laravel-trailing-slash.svg?style=flat-square)](https://scrutinizer-ci.com/g/gnahotelsolutions/laravel-trailing-slash)
66
[![Total Downloads](https://img.shields.io/packagist/dt/gnahotelsolutions/laravel-trailing-slash.svg?style=flat-square)](https://packagist.org/packages/gnahotelsolutions/laravel-trailing-slash)
77

8-
This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors.
8+
With this package you will be able to end your Laravel project routes with trailing slash.
99

1010
## Installation
1111

@@ -17,8 +17,24 @@ composer require gnahotelsolutions/laravel-trailing-slash
1717

1818
## Usage
1919

20-
``` php
21-
// Usage description here
20+
When installed you are ready to go!
21+
22+
Optionally, you can publish the config file of the package.
23+
24+
```
25+
php artisan vendor:publish --provider="GnaHotelSolutions\LaravelTrailingSlash\LaravelTrailingSlashServiceProvider" --tagconfig
26+
```
27+
## Disable Laravel Trailing Slash
28+
Place this variable in your .env
29+
30+
```
31+
TRAILING_SLASH=false
32+
```
33+
34+
## Disable Laravel Trailing Slash integration in tests
35+
36+
```php
37+
config()->set('laravel-trailing-slash.active', false);
2238
```
2339

2440
### Testing
@@ -50,4 +66,4 @@ The MIT License (MIT). Please see [License File](LICENSE.md) for more informatio
5066

5167
## Laravel Package Boilerplate
5268

53-
This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com).
69+
This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com).

0 commit comments

Comments
 (0)