From ed319b4060db0149dbfafc02bf2d2e5dd0ba973b Mon Sep 17 00:00:00 2001
From: Gabeta Soro <gabeta.soro@gmail.com>
Date: Mon, 1 Feb 2021 10:10:34 +0000
Subject: [PATCH] doc

---
 README.md          |  8 ++++++++
 config/larapnn.php | 29 ++++++++++++++++++++++++-----
 2 files changed, 32 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 96536ea..1b794de 100644
--- a/README.md
+++ b/README.md
@@ -120,3 +120,11 @@ You also have a command that allows you to rollback
 ```shell
 php artisan larapnn:rollback YouModelNamepace\\YourModel
 ```
+
+You can add the skip option to skip the stats part (used if you are using a job):
+
+```shell
+php artisan larapnn:migrate YouModelNamepace\\YourModel --skip
+
+php artisan larapnn:rollback YouModelNamepace\\YourModel --skip
+```
diff --git a/config/larapnn.php b/config/larapnn.php
index f436f7a..698f556 100644
--- a/config/larapnn.php
+++ b/config/larapnn.php
@@ -1,14 +1,37 @@
 <?php
 
 return [
-
+    /**
+     * When the dial code and the number are in the same field,
+     * this parameter is used to filter the Ivorian numbers.
+     */
     'dial_code' => ['225', '00225', '+225'],
 
+    /**
+     * this parameter is used to make the number in a string composed only of digits
+     * If in database your contacts were formatted with () you must add them as a parameter.
+     */
+    'separators' => [
+        ' ', '-'
+    ],
+
+    /**
+     * Formatting the number after processing
+     */
     'format' => [
+        /**
+         * Separator used after formatting
+         */
         'separator' => ' ',
 
+        /**
+         * number formatting after migration
+         */
         'model_migrate' => 'XX-XX-XX-XX-XX',
 
+        /**
+         * number formatting after migration
+         */
         'model_rollback' => 'XX-XX-XX-XX'
     ],
 
@@ -61,8 +84,4 @@
             ],
         ]
     ],
-
-    'separators' => [
-        ' ', '-'
-    ],
 ];