Skip to content

Commit b0e7d87

Browse files
authored
Merge pull request #7 from abdumu/master
add docs
2 parents 9f632bf + 2827ad6 commit b0e7d87

File tree

4 files changed

+64
-0
lines changed

4 files changed

+64
-0
lines changed

docs/1_introduction.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
prev: ./
3+
next: 2_installation
4+
---
5+
6+
# Introduction
7+
It's a tool to help ease the repetitive migration process during developing a Laravel project without migrate:fresh your database every time you change you schemas.
8+
9+
10+
## Features
11+
- Easy to install, no need to add or change your schemas or project files.
12+
- Sync schema changes to database instantly. No need to repeat fresh or seed commands everytime.
13+
- Interactive. It will give you choices to not force unwanted changes to your database.

docs/2_installation.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
prev: 1_introduction
3+
next: 2_quick-start
4+
---
5+
6+
# Installation
7+
8+
To get started, use Composer to add the package to your project's dependencies:
9+
```bash
10+
composer require awssat/laravel-sync-migration
11+
```
12+
13+
#### Before Laravel 5.5
14+
In Laravel 5.4. you'll manually need to register the `Awssat\SyncMigration\SyncMigrationServiceProvider::class` service provider in `config/app.php`.

docs/2_quick-start.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
prev: 2_installation
3+
next: false
4+
---
5+
6+
7+
# Quick Start
8+
9+
## Start using it
10+
It's simple. Anytime you want sync schema files to database run this command:
11+
```sh
12+
php artisan migrate:sync
13+
```
14+
15+
## how to use (gif image)
16+
<p align="center">
17+
<img src="https://thumbs.gfycat.com/SplendidFlatAustrianpinscher-size_restricted.gif" alt="Laravel Sync Migration">
18+
</p>

docs/index.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
prev: false
3+
next: 1_introduction
4+
---
5+
6+
# Laravel Sync Migration
7+
8+
<p align="center">
9+
<img src="https://i.imgur.com/OP83jHA.jpg" alt="Laravel Sync Migration" style="width:400px">
10+
</p>
11+
12+
13+
### Contributing
14+
15+
Please see [the package github repo](https://github.com/awssat/laravel-sync-migration) for details.
16+
17+
### License
18+
19+
The MIT License (MIT).

0 commit comments

Comments
 (0)