Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
khanzadimahdi committed Jun 14, 2019
1 parent b4e155c commit b627daf
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<p align="center"><img src="resources/images/stamp.jpg?raw=true"></p>

# Laravel Stampable

[![Software License][ico-license]](LICENSE.md)
Expand Down Expand Up @@ -30,6 +32,8 @@ Via Composer
$ composer require shetabit/stampable
```

# How to use

## Configure Migration

In your migration you must add `timestamp` field per each stamp.
Expand Down Expand Up @@ -85,7 +89,9 @@ class Category extends Model implements Stampable
}
```

stamps must be in ['stampName' => 'databaseFieldName'] format.
stamps must be in `['stampName' => 'databaseFieldName']` format.

## Working with stamps

Model creates methods and local scopes for each stamp dynamically.

Expand Down

0 comments on commit b627daf

Please sign in to comment.