Skip to content
This repository was archived by the owner on Feb 24, 2025. It is now read-only.

Commit f6f2154

Browse files
committed
license and readme
1 parent 4bf9a3d commit f6f2154

File tree

2 files changed

+69
-0
lines changed

2 files changed

+69
-0
lines changed

LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) Coding Labs Pty Ltd <steve@codinglabs.com.au>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Laravel Sluggable
2+
3+
[![Build Status](https://travis-ci.org/codinglabsau/laravel-sluggable.svg?branch=master)](https://travis-ci.org/codinglabsau/laravel-sluggable)
4+
[![Latest Stable Version](https://poser.pugx.org/codinglabsau/laravel-sluggable/v/stable)](https://packagist.org/packages/codinglabsau/laravel-sluggable)
5+
[![Total Downloads](https://poser.pugx.org/codinglabsau/laravel-sluggable/downloads)](https://packagist.org/packages/codinglabsau/laravel-sluggable)
6+
[![License](https://poser.pugx.org/codinglabsau/laravel-sluggable/license)](https://packagist.org/packages/codinglabsau/laravel-sluggable)
7+
8+
A super simple, opinionated trait to add slugs to models in Laravel.
9+
10+
## Installation
11+
Via Composer
12+
13+
``` bash
14+
$ composer require codinglabsau/laravel-sluggable
15+
```
16+
17+
## Usage
18+
### Add `name` and `slug` columns to your model
19+
This package watches for changes on the `name` attribute, and automatically slugifies the slug column.
20+
21+
### Add the trait
22+
Add the `Sluggable` trait to your user model:
23+
24+
```php
25+
use Codinglabs\Sluggable\Sluggable;
26+
use Illuminate\Database\Eloquent\Model;
27+
28+
class Product extends Model
29+
{
30+
use Sluggable;
31+
}
32+
```
33+
34+
## Contributing
35+
Feel free to create a PR with tests!
36+
37+
## Security
38+
If you discover any security related issues, create an issue on GitHub.
39+
40+
## Credits
41+
- [Steve Thomas](https://github.com/stevethomas)
42+
- [All Contributors](../../contributors)
43+
44+
## License
45+
MIT. Please see the [license file](LICENSE.md) for more information.
46+
47+
## About Coding Labs
48+
Coding Labs is a web app development agency based on the Gold Coast, Australia. See our open source projects [on our website](https://codinglabs.com.au/open-source).

0 commit comments

Comments
 (0)