Skip to content

Commit 52c1615

Browse files
committed
Updated readme
1 parent 3e43a32 commit 52c1615

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[![Total Downloads](https://img.shields.io/packagist/dt/chrisjk123/blogger.svg?style=flat-square)](https://packagist.org/packages/chrisjk123/blogger)
77

88

9-
This package offers fully blog database tables as well as preset models with relations, scopes and seeders.
9+
This package is a blogging database with maxed out models, migrations and seeders to help get you setup. After the package is installed the only thing you have to do is add the `Chrisjk123\Blogger\Traits\User\HasPosts` trait to an Eloquent model to associate the users.
1010

1111
Here are some code examples:
1212

@@ -89,10 +89,23 @@ You can publish the seeder with:
8989
php artisan vendor:publish --provider="Chrisjk123\Blogger\BloggerServiceProvider" --tag="seeders"
9090
```
9191

92-
## Usage
92+
## Documentation
93+
94+
All you have to do is add the `HasPosts` to your User model to get started.
9395

9496
``` php
95-
// Usage description here
97+
namespace App;
98+
99+
use Chrisjk123\Blogger\Traits\User\HasPosts;
100+
use Illuminate\Foundation\Auth\User as Authenticatable;
101+
use Illuminate\Notifications\Notifiable;
102+
103+
class User extends Authenticatable
104+
{
105+
use Notifiable, HasPosts;
106+
107+
// ...
108+
}
96109
```
97110
### Changelog
98111

0 commit comments

Comments
 (0)