Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
myaaghubi committed Oct 31, 2020
1 parent b6b52a9 commit 5e51954
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,11 @@ It's something like version control for the sql databases. Every time you have t
- [First migration case](#first-migration-case)
- [Migrate](#migrate)
- [Config](#config)
- [Logging](#logging)
- [CLI mode](#cli-mode)
- [Migration cases](#migration-cases)
- [Filename](#filename)
- [Content](#content)
- [Logging](#logging)
- [License](#license)

## Installation
Expand All @@ -23,7 +24,10 @@ If you use composer, run the below code:
```
composer require myaghobi/f3-migrations
```
For manual installation, copy the content of `lib/` folder into your `lib/` folder. Also, `Migrations` use [Schema Builder](https://github.com/ikkez/f3-schema-builder), so you need to install it too.
For manual installation:
1. Copy the content of `lib/` folder into your `lib/` folder.
2. Install [Schema Builder](https://github.com/ikkez/f3-schema-builder) as mentioned in its documentation.
3. Install Html2Text, by placing the `html2text.php` inside of a folder named `html2text` in your `lib/`.


## Operation and basic usage
Expand Down Expand Up @@ -73,6 +77,17 @@ LOG=true
```
The above config is the default, you can ignore/remove each one you don't need to change.

### Logging

You can find the logs of actions in `migrations.log` located in the [LOGS](http://fatfreeframework.com/quick-reference#LOGS) folder.

### CLI mode

Just run the below code:
```
php index.php /migrations
```

## Migration cases

### Filename
Expand Down Expand Up @@ -126,10 +141,6 @@ class CreateProductsTable extends \DB\SQL\MigrationCase {
?>
```

## Logging

You can find the logs of actions in `migrations.log` located in the [LOGS](http://fatfreeframework.com/quick-reference#LOGS) folder.

## License

You are allowed to use this plugin under the terms of the GNU General Public License version 3 or later.
Expand Down

0 comments on commit 5e51954

Please sign in to comment.