From b627daf0875b33b539dfd877c36ac8b956a60fdc Mon Sep 17 00:00:00 2001 From: mahdi khanzadi Date: Fri, 14 Jun 2019 12:02:41 +0430 Subject: [PATCH] fix docs --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f66cc44..9a5de40 100755 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +

+ # Laravel Stampable [![Software License][ico-license]](LICENSE.md) @@ -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. @@ -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.