Skip to content

Commit

Permalink
readme+docs: more info about supported platforms & extensions
Browse files Browse the repository at this point in the history
  • Loading branch information
hrach committed Mar 24, 2017
1 parent eccf124 commit fa0f8c4
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
9 changes: 8 additions & 1 deletion doc/default.texy
@@ -1,12 +1,19 @@
Nextras Dbal
############

A powerful abstraction layer for database. **Fast & Save**.

Supported platforms:
- **MySQL** via mysqli extension,
- **PostgreSQL** via pgsql extension,
- **MS SQL Server** via sqlsrv extension.

Connection
==========

The connection instance is the main object which provides API for working with your database. Connection's constructor accepts a configuration array. The possible keys depend on the current driver, although some configuration keys are the same for all drivers:

|* driver | driver name, use `mysqli` or `pgsql`
|* driver | driver name, use `mysqli`, `pgsql`, or `sqlsrv`
|* host | database server name
|* username | username for authentication
|* password | password for authentication
Expand Down
7 changes: 7 additions & 0 deletions readme.md
Expand Up @@ -7,6 +7,13 @@ Nextras Dbal
[![Stable Version](https://poser.pugx.org/nextras/dbal/v/stable)](https://packagist.org/packages/nextras/dbal)
[![Code coverage](https://img.shields.io/coveralls/nextras/dbal.svg?style=flat)](https://coveralls.io/r/nextras/dbal)

A powerful abstraction layer for database. **Fast & Save**.

Supported platforms:
- **MySQL** via mysqli extension,
- **PostgreSQL** via pgsql extension,
- **MS SQL Server** via sqlsrv extension.

### Installation

Use composer:
Expand Down

0 comments on commit fa0f8c4

Please sign in to comment.