Skip to content

Commit 58f1062

Browse files
committed
Add installation instructions
1 parent 3641ac5 commit 58f1062

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

readme.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22

33
Laravel utility to keep records synced between enviroments through source control
44

5-
5+
## Installation & Usage
6+
- Via composer: `composer require distinctm/laravel-data-sync`
7+
- 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)
68
- Create a JSON file for each model, using the model name as the filename. Example: Product.json would update the Product model
79
- Use nested arrays in place of hardcoded IDs for relationships
8-
- 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)
910
- Run `php artisan data:sync` (or `php artisan data:sync --model={model}` with the model flag to specify a model)
1011

1112
### Optional

0 commit comments

Comments
 (0)