Skip to content

Commit 7d13851

Browse files
committed
update readme and docs
1 parent 9ad90dd commit 7d13851

File tree

4 files changed

+37
-19
lines changed

4 files changed

+37
-19
lines changed

README.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,24 @@
44
<img src="https://i.imgur.com/OP83jHA.jpg" alt="Laravel Sync Migration">
55
</p>
66

7-
87
[![Latest Version on Packagist][ico-version]][link-packagist]
98
[![Software License][ico-license]](LICENSE.md)
109
[![Build Status][ico-travis]][link-travis]
1110
[![Quality Score][ico-code-quality]][link-code-quality]
1211
[![Total Downloads][ico-downloads]][link-downloads]
1312

14-
1513
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.
1614

17-
18-
1915
## Docs
20-
You can start reading the docs of Laravel Sync Migration on our website [ [docs](https://awssat.com/opensource/laravel-sync-migration) ].
21-
2216

17+
- [Introduction](docs/1_introduction.md)
18+
- [Installation](docs/2_installation.md)
19+
- [Quick start](docs/3_quick-start.md)
2320

2421
## Credits
2522

26-
- [Bader][link-author]
27-
- [All Contributors][link-contributors]
23+
- [Bader][link-author]
24+
- [All Contributors][link-contributors]
2825

2926
## License
3027

@@ -35,7 +32,6 @@ The MIT License (MIT). Please see [License File](LICENSE.md) for more informatio
3532
[ico-travis]: https://travis-ci.org/awssat/laravel-sync-migration.svg?branch=master
3633
[ico-code-quality]: https://scrutinizer-ci.com/g/awssat/laravel-sync-migration/badges/quality-score.png?b=master
3734
[ico-downloads]: https://img.shields.io/packagist/dt/awssat/laravel-sync-migration.svg?style=flat-square
38-
3935
[link-packagist]: https://packagist.org/packages/awssat/laravel-sync-migration
4036
[link-travis]: https://travis-ci.org/awssat/laravel-sync-migration
4137
[link-scrutinizer]: https://scrutinizer-ci.com/g/awssat/laravel-sync-migration/code-structure

docs/1_introduction.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,17 @@ next: 2_installation
44
---
55

66
# 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.
87

8+
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.
99

1010
## 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.
11+
12+
- Easy to install, no need to add or change your schemas or project files.
13+
- Sync schema changes to database instantly. No need to repeat fresh or seed commands everytime.
14+
- Interactive. It will give you choices to not force unwanted changes to your database.
15+
16+
---
17+
18+
<p align="right">
19+
Next: <a href="2_installation.md">Installation ></a>
20+
</p>

docs/2_installation.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,21 @@ next: 2_quick-start
66
# Installation
77

88
To get started, use Composer to add the package to your project's dependencies:
9+
910
```bash
1011
composer require awssat/laravel-sync-migration
1112
```
1213

1314
#### Before Laravel 5.5
15+
1416
In Laravel 5.4. you'll manually need to register the `Awssat\SyncMigration\SyncMigrationServiceProvider::class` service provider in `config/app.php`.
17+
18+
---
19+
20+
<p align="left">
21+
Prev: <a href="1_introduction.md">< Introduction</a>
22+
</p>
23+
24+
<p align="right">
25+
Next: <a href="4_quick-start.md">Quick start ></a>
26+
</p>
Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
1-
---
2-
prev: 2_installation
3-
next: false
4-
---
5-
6-
71
# Quick Start
82

93
## Start using it
4+
105
It's simple. Anytime you want sync schema files to database run this command:
6+
117
```sh
128
php artisan migrate:sync
139
```
1410

1511
## how to use (gif image)
12+
1613
<p align="center">
1714
<img src="https://thumbs.gfycat.com/SplendidFlatAustrianpinscher-size_restricted.gif" alt="Laravel Sync Migration">
1815
</p>
16+
17+
---
18+
19+
<p align="left">
20+
Prev: <a href="2_installation.md">< Installation</a>
21+
</p>

0 commit comments

Comments
 (0)