Skip to content

Commit c1b4560

Browse files
committed
doc(readme): installation, usage, license and about sections
1 parent 37eccee commit c1b4560

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,38 @@
11
# Laravel Publishable
22

33
Laravel package for handling publishable resources.
4+
5+
6+
## Installation
7+
8+
Add the package to your Laravel app using composer
9+
10+
```
11+
composer require codetech/laravel-publishable
12+
```
13+
14+
15+
## Usage
16+
17+
To start using publishable features, simply use the trait on your models.
18+
19+
```
20+
class Post extends Model
21+
{
22+
use Publishable;
23+
24+
...
25+
```
26+
27+
28+
---
29+
30+
31+
## License
32+
33+
**codetech/laravel-publishable** is open-sourced software licensed under the [MIT license](https://github.com/CodeTechPt/laravel-publishable/blob/master/LICENSE).
34+
35+
36+
## About CodeTech
37+
38+
[CodeTech](https://www.codetech.pt) is a web development agency based on Matosinhos, Portugal. Oh, and we LOVE Laravel!

0 commit comments

Comments
 (0)