diff --git a/README.md b/README.md index eab3a03..952d03b 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,18 @@ - +

Oracle driver for Yii Database


+[![Latest Stable Version](https://poser.pugx.org/yiisoft/db-oracle/v/stable.png)](https://packagist.org/packages/yiisoft/db-oracle) +[![Total Downloads](https://poser.pugx.org/yiisoft/db-oracle/downloads.png)](https://packagist.org/packages/yiisoft/db-oracle) +[![rector](https://github.com/yiisoft/db-oracle/actions/workflows/rector.yml/badge.svg)](https://github.com/yiisoft/db-oracle/actions/workflows/rector.yml) +[![codecov](https://codecov.io/gh/yiisoft/db-oracle/branch/master/graph/badge.svg?token=XGJAFXVHSH)](https://codecov.io/gh/yiisoft/db-oracle) +[![StyleCI](https://github.styleci.io/repos/114756574/shield?branch=master)](https://github.styleci.io/repos/114756574?branch=master) + Oracle driver for [Yii Database](https://github.com/yiisoft/db) is a database driver for [Oracle] databases. The package allows you to connect to [Oracle] databases from your application and perform various database operations @@ -21,35 +27,35 @@ your Oracle database and perform various database operations as needed. [Oracle]: https://www.oracle.com/database/technologies/ -[![Latest Stable Version](https://poser.pugx.org/yiisoft/db-oracle/v/stable.png)](https://packagist.org/packages/yiisoft/db-oracle) -[![Total Downloads](https://poser.pugx.org/yiisoft/db-oracle/downloads.png)](https://packagist.org/packages/yiisoft/db-oracle) -[![rector](https://github.com/yiisoft/db-oracle/actions/workflows/rector.yml/badge.svg)](https://github.com/yiisoft/db-oracle/actions/workflows/rector.yml) -[![codecov](https://codecov.io/gh/yiisoft/db-oracle/branch/master/graph/badge.svg?token=XGJAFXVHSH)](https://codecov.io/gh/yiisoft/db-oracle) -[![StyleCI](https://github.styleci.io/repos/114756574/shield?branch=master)](https://github.styleci.io/repos/114756574?branch=master) - ## Support version -| PHP | Oracle Version | CI-Actions -|:----:|:------------------------:|:---:| +| PHP | Oracle Version | CI-Actions +|----|------------------------|---| |**8.0 - 8.2**| **12c - 21c**|[![build](https://github.com/yiisoft/db-oracle/actions/workflows/build.yml/badge.svg?branch=dev)](https://github.com/yiisoft/db-oracle/actions/workflows/build.yml) [![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fyiisoft%2Fdb-oracle%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/db-oracle/master) [![static analysis](https://github.com/yiisoft/db-oracle/actions/workflows/static.yml/badge.svg?branch=dev)](https://github.com/yiisoft/db-oracle/actions/workflows/static.yml) [![type-coverage](https://shepherd.dev/github/yiisoft/db-oracle/coverage.svg)](https://shepherd.dev/github/yiisoft/db-oracle) ## Installation -The package could be installed via composer: +The package could be installed with [Composer](https://getcomposer.org): ```php composer require yiisoft/db-oracle ``` -## Usage +## Documentation -For config connection to Oracle database check [Connecting Oracle](https://github.com/yiisoft/db/blob/master/docs/en/connection/oracle.md). +- For config connection to Oracle database check [Connecting Oracle](https://github.com/yiisoft/db/blob/master/docs/en/connection/oracle.md). +- [Check the documentation docs](https://github.com/yiisoft/db/blob/master/docs/en/README.md) to learn about usage. +- [Internals](docs/internals.md) -[Check the documentation docs](https://github.com/yiisoft/db/blob/master/docs/en/README.md) to learn about usage. +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). -## Testing +## 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. -[Check the documentation](/docs/en/testing.md) to learn about testing. +Maintained by [Yii Software](https://www.yiiframework.com/). ## Support the project @@ -62,10 +68,3 @@ For config connection to Oracle database check [Connecting Oracle](https://githu [![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/en/testing.md b/docs/internals.md similarity index 87% rename from docs/en/testing.md rename to docs/internals.md index c715b19..015745d 100644 --- a/docs/en/testing.md +++ b/docs/internals.md @@ -1,4 +1,4 @@ -# Testing +# Internals ## Github actions @@ -20,9 +20,7 @@ docker compose up -d ## Unit testing -The package is tested with [PHPUnit](https://phpunit.de/). - -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. 2. Install the dependencies of the project with composer. @@ -32,7 +30,7 @@ The following steps are required to run the tests: vendor/bin/phpunit ``` -### Mutation testing +## Mutation testing The package tests are checked with [Infection](https://infection.github.io/) mutation framework with [Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it: @@ -51,8 +49,8 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static ## Rector -Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or -use either newest or any specific version of PHP: +Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or +use either newest or any specific version of PHP: ```shell ./vendor/bin/rector