Skip to content

Commit

Permalink
Update file (#258)
Browse files Browse the repository at this point in the history
Co-authored-by: Sergei Predvoditelev <[email protected]>
  • Loading branch information
luizcmarin and vjik authored May 7, 2024
1 parent 8de2712 commit 1212ef4
Show file tree
Hide file tree
Showing 8 changed files with 21 additions and 207 deletions.
6 changes: 3 additions & 3 deletions LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

* Redistributions of source code must retain the above copyright
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
* Neither the name of Yii Software nor the names of its
* Neither the name of Yii Software nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.

Expand Down
34 changes: 10 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,23 +32,15 @@ Supports the following databases out of the box:

## Installation

The preferred way to install this extension is through [composer](https://getcomposer.org/download/).

Either run:
The package could be installed with [Composer](https://getcomposer.org):

```shell
composer require yiisoft/db-migration
```

or add to the `require` section of your `composer.json`:

```json
"yiisoft/db-migration": "^1.0"
```

## Command list

```shell
```text
migrate:create Creates a new migration.
migrate:down Reverts the specified number of latest migrations.
migrate:history Displays the migration history.
Expand All @@ -61,18 +53,19 @@ The create command allows defining fields for the table being created.

## Documentation

- [English](docs/guide/en/readme.md)
- [Português - Brasil](docs/guide/pt-BR/readme.md)

Testing:

- [Guide](docs/guide/en/README.md)
- [Internals](docs/internals.md)

## Support

If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.
You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).

## License

The Yii DB Migration is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.

Maintained by [Yii Software](https://www.yiiframework.com/).

## Support the project

[![Open Collective](https://img.shields.io/badge/Open%20Collective-sponsor-7eadf1?logo=open%20collective&logoColor=7eadf1&labelColor=555555)](https://opencollective.com/yiisoft)
Expand All @@ -84,10 +77,3 @@ You may also check out other [Yii Community Resources](https://www.yiiframework.
[![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en)
[![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk)
[![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack)

## License

The Yii Db Migration is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.

Maintained by [Yii Software](https://www.yiiframework.com/).
File renamed without changes.
4 changes: 4 additions & 0 deletions docs/guide/en/usage-with-yii-console.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ In this example, we use [yiisoft/app](https://github.com/yiisoft/app).
First, configure DI container. Create `config/common/db.php` with the following content:

```php
<?php

declare(strict_types=1);

use Yiisoft\Db\Connection\ConnectionInterface;
use Yiisoft\Db\Sqlite\Connection as SqliteConnection;

Expand Down
70 changes: 0 additions & 70 deletions docs/guide/pt-BR/usage-standalone.md

This file was deleted.

55 changes: 0 additions & 55 deletions docs/guide/pt-BR/usage-with-symfony.md

This file was deleted.

42 changes: 0 additions & 42 deletions docs/guide/pt-BR/usage-with-yii-console.md

This file was deleted.

17 changes: 4 additions & 13 deletions docs/internals.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ docker compose up -d

### Global testing

The following steps are required to run the tests.
The package is tested with [PHPUnit](https://phpunit.de/). To run tests:

1. Run all Docker containers for each dbms.
2. Install the dependencies of the project with composer.
Expand All @@ -46,7 +46,7 @@ vendor/bin/phpunit

### Individual testing

The following steps are required to run the tests.
The package is tested with [PHPUnit](https://phpunit.de/). To run tests:

1. Run the Docker container for the dbms you want to test.
2. Install the dependencies of the project with composer.
Expand All @@ -64,14 +64,6 @@ Suites available:
- Pgsql
- Sqlite

## Unit testing

The package is tested with [PHPUnit](https://phpunit.de/). To run tests:

```shell
./vendor/bin/phpunit
```

## Mutation testing

The package tests are checked with [Infection](https://infection.github.io/) mutation framework with
Expand Down Expand Up @@ -100,9 +92,8 @@ use either newest or any specific version of PHP:

## Dependencies

This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all dependencies are correctly defined in `composer.json`.

To run the checker, execute the following command:
This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if
all dependencies are correctly defined in `composer.json`. To run the checker, execute the following command:

```shell
./vendor/bin/composer-require-checker
Expand Down

0 comments on commit 1212ef4

Please sign in to comment.