Skip to content

Commit 3226fd8

Browse files
authored
Improve README (#377)
1 parent e8bbf0e commit 3226fd8

File tree

1 file changed

+18
-27
lines changed

1 file changed

+18
-27
lines changed

README.md

Lines changed: 18 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,52 +5,43 @@
55
<a href="https://www.oracle.com/database/technologies/" target="_blank">
66
<img src="https://avatars3.githubusercontent.com/u/4430336" height="100px" alt="Oracle">
77
</a>
8-
<h1 align="center">Yii Database Oracle driver</h1>
8+
<h1 align="center">Yii Database Oracle Driver</h1>
99
<br>
1010
</p>
1111

1212
[![Latest Stable Version](https://poser.pugx.org/yiisoft/db-oracle/v)](https://packagist.org/packages/yiisoft/db-oracle)
1313
[![Total Downloads](https://poser.pugx.org/yiisoft/db-oracle/downloads)](https://packagist.org/packages/yiisoft/db-oracle)
14-
[![rector](https://github.com/yiisoft/db-oracle/actions/workflows/rector.yml/badge.svg)](https://github.com/yiisoft/db-oracle/actions/workflows/rector.yml)
15-
[![codecov](https://codecov.io/gh/yiisoft/db-oracle/branch/master/graph/badge.svg?token=XGJAFXVHSH)](https://codecov.io/gh/yiisoft/db-oracle)
16-
[![StyleCI](https://github.styleci.io/repos/114756574/shield?branch=master)](https://github.styleci.io/repos/114756574?branch=master)
14+
[![Build status](https://github.com/yiisoft/db-oracle/actions/workflows/build.yml/badge.svg)](https://github.com/yiisoft/db-oracle/actions/workflows/build.yml)
15+
[![Code Coverage](https://codecov.io/gh/yiisoft/db-oracle/branch/master/graph/badge.svg?token=UF9VERNMYU)](https://codecov.io/gh/yiisoft/db-oracle)
16+
[![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)
17+
[![static analysis](https://github.com/yiisoft/db-oracle/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/db-oracle/actions?query=workflow%3A%22static+analysis%22)
18+
[![type-coverage](https://shepherd.dev/github/yiisoft/db-oracle/coverage.svg)](https://shepherd.dev/github/yiisoft/db-oracle)
19+
[![psalm-level](https://shepherd.dev/github/yiisoft/db-oracle/level.svg)](https://shepherd.dev/github/yiisoft/db-oracle)
1720

18-
Oracle driver for [Yii Database](https://github.com/yiisoft/db) is a database driver for [Oracle] databases.
21+
Oracle driver for [Yii Database](https://github.com/yiisoft/db) is a package for working with
22+
[Oracle](https://www.oracle.com/database/technologies/) databases in PHP. It includes a database connection class,
23+
a command builder class, and a set of classes for representing database tables and rows as PHP objects.
1924

20-
The package allows you to connect to [Oracle] databases from your application and perform various database operations
21-
such as executing queries, creating and modifying database schema, and processing data. It supports a wide range of
22-
[Oracle] versions and provides a simple and efficient interface for working with [Oracle] databases.
23-
24-
To use the package, you need to have the [Oracle] client library installed and configured on your server, and you need
25-
to specify the correct database connection parameters. Once you have done this, you can use the driver to connect to
26-
your Oracle database and perform various database operations as needed.
27-
28-
[Oracle]: https://www.oracle.com/database/technologies/
29-
30-
## Support version
31-
32-
| PHP | Oracle Version | CI-Actions |
33-
|---------------|----------------|------------|
34-
| **8.1 - 8.4** | **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)
25+
Driver supports Oracle 12c - 21c.
3526

3627
## Installation
3728

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

40-
```php
31+
```shell
4132
composer require yiisoft/db-oracle
4233
```
4334

4435
> [!IMPORTANT]
45-
> It also depends on [PSR-16: Common Interface for Caching Libraries](https://www.php-fig.org/psr/psr-16/) and requires
46-
> the installation of [PSR-16 implementation](https://packagist.org/providers/psr/simple-cache-implementation).
47-
> For example, [yiisoft/cache](https://github.com/yiisoft/cache) or one of the other [cache handlers](https://github.com/yiisoft/cache#cache-handlers).
36+
> See also [installation notes](https://github.com/yiisoft/db/?tab=readme-ov-file#installation) for `yiisoft/db`
37+
> package.
4838
4939
## Documentation
5040

51-
For config connection to Oracle database check [Connecting Oracle](https://github.com/yiisoft/db/blob/master/docs/guide/en/connection/oracle.md).
41+
For config connection to Oracle database check
42+
[Connecting Oracle](https://github.com/yiisoft/db/blob/master/docs/guide/en/connection/oracle.md).
5243

53-
[Check the documentation docs](https://github.com/yiisoft/db/blob/master/docs/guide/en/README.md) to learn about usage.
44+
Check the `yiisoft/db` [docs](https://github.com/yiisoft/db/blob/master/docs/guide/en/README.md) to learn about usage.
5445

5546
- [Internals](docs/internals.md)
5647

@@ -59,7 +50,7 @@ You may also check out other [Yii Community Resources](https://www.yiiframework.
5950

6051
## License
6152

62-
The Yii Database Oracle driver is free software. It is released under the terms of the BSD License.
53+
The Yii Database Oracle Driver is free software. It is released under the terms of the BSD License.
6354
Please see [`LICENSE`](./LICENSE.md) for more information.
6455

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

0 commit comments

Comments
 (0)