From b5eacfb0f7ba8aef744f9a56872a0c33c5c5b8e9 Mon Sep 17 00:00:00 2001 From: Mateus Junges Date: Thu, 20 Jun 2019 13:37:33 -0300 Subject: [PATCH] Refactor README.md --- readme.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 4d2bbcc..de6787d 100644 --- a/readme.md +++ b/readme.md @@ -1,9 +1,30 @@ +

+Total Downloads +Latest Stable Version +

+ # Laravel Data Sync Laravel utility to keep records synced between environments through source control -## Installation & Usage -- Via composer: `composer require distinctm/laravel-data-sync` +## Installation +You can install this package via composer: +```bash +composer require distinctm/laravel-data-sync +``` + +Or add this line in your `composer.json`, inside of the `require` section: + +``` json +{ + "require": { + "distinctm/laravel-data-sync": "^1.0", + } +} +``` +then run ` composer install ` + +## Usage - Run `php artisan vendor:publish --provider="distinctm\LaravelDataSync\DataSyncBaseServiceProvider" --tag="data-sync-config"` to publish config file. Specify directory for sync data files (default is a new sync directory in the project root) - Create a JSON file for each model, using the model name as the filename. Example: Product.json would update the Product model - Use nested arrays in place of hardcoded IDs for relationships