diff --git a/README.md b/README.md index a35d40b..f17f498 100644 --- a/README.md +++ b/README.md @@ -40,24 +40,21 @@ The package could be installed via composer: ```shell composer require yiisoft/db-oracle ``` -# Documentation - -## English -- For config connection to Oracle database check [Connecting Oracle](https://github.com/yiisoft/db/blob/master/docs/guide/en/connection/oracle.md). -- [Check the documentation](https://github.com/yiisoft/db/blob/master/docs/guide/en/README.md) to learn about usage. +# Documentation -## Português - Brasil +- Guide: [English](/docs/guide/en/README.md), [Português - Brasil](docs/guide/pt-BR/README.md) +- [Internals](docs/internals.md) -- Para configurar a conexão com o Oracle leia [Connecting Oracle](https://github.com/yiisoft/db/blob/master/docs/guide/pt-BR/connection/oracle.md). -- [Confira a documentação](https://github.com/yiisoft/db/blob/master/docs/guide/pt-BR/README.md) para aprender como usar. +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). -- [Internals](internals.md) +## License -## Support +The Oracle driver for Yii Database is free software. It is released under the terms of the BSD License. +Please see [`LICENSE`](./LICENSE.md) for more information. -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). +Maintained by [Yii Software](https://www.yiiframework.com/). ## Support the project @@ -70,10 +67,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 Framework Oracle Extension 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/). diff --git a/docs/guide/en/README.md b/docs/guide/en/README.md new file mode 100644 index 0000000..a23e648 --- /dev/null +++ b/docs/guide/en/README.md @@ -0,0 +1,5 @@ +# Oracle driver for Yii Database + +- For config connection to Oracle database check + [Connecting Oracle](https://github.com/yiisoft/db/blob/master/docs/guide/en/connection/oracle.md). +- [Check the documentation](https://github.com/yiisoft/db/blob/master/docs/guide/en/README.md) to learn about usage. diff --git a/docs/guide/pt-BR/README.md b/docs/guide/pt-BR/README.md new file mode 100644 index 0000000..efc5dd2 --- /dev/null +++ b/docs/guide/pt-BR/README.md @@ -0,0 +1,6 @@ +# Oracle driver for Yii Database + +- Para configurar a conexão com o Oracle leia + [Connecting Oracle](https://github.com/yiisoft/db/blob/master/docs/guide/pt-BR/connection/oracle.md). +- [Confira a documentação](https://github.com/yiisoft/db/blob/master/docs/guide/pt-BR/README.md) para aprender como + usar. diff --git a/docs/internals.md b/docs/internals.md index c62f1bc..d2d0865 100644 --- a/docs/internals.md +++ b/docs/internals.md @@ -49,7 +49,7 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static ./vendor/bin/psalm ``` -## Rector +## Code style Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or use either newest or any specific version of PHP: @@ -58,11 +58,10 @@ use either newest or any specific version of PHP: ./vendor/bin/rector ``` -## Composer require checker +## 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