11# chillerlan/database
22
3+ A PHP7 SQL client and querybuilder for the most common databases.
4+
35[ ![ version] [ packagist-badge ]] [ packagist ]
46[ ![ license] [ license-badge ]] [ license ]
57[ ![ Travis] [ travis-badge ]] [ travis ]
2022[ codeclimate-badge ] : https://img.shields.io/codeclimate/github/codemasher/php-database.svg
2123[ codeclimate ] : https://codeclimate.com/github/codemasher/php-database
2224
23- # Requirements
25+ # Documentation
26+
27+ ## Requirements
2428- PHP 7+
29+ - one of the supported databases, set up to work with PHP
2530
26- # Supported databases
31+ ## Supported databases
2732- MySQL/MariaDB (native, PDO, ODBC)
2833- PostgreSQL (native, PDO, ODBC)
2934- Microsoft SQL Server (native, PDO, ODBC)
3035- SQLite3 (PDO)
3136- Firebird (PDO)
3237- any other database supported via PDO, ODBC or native PHP extension
3338
34- # Documentation
3539## Installation
36- ### Using [ composer] ( https://getcomposer.org )
37-
38- * Terminal*
39- ``` sh
40- composer require chillerlan/database:dev-master
41- ```
40+ ** requires [ composer] ( https://getcomposer.org ) **
4241
43- * composer.json*
42+ ### * composer.json*
43+ (note: replace ` dev-master ` with a [ version boundary] ( https://getcomposer.org/doc/articles/versions.md#summary ) )
4444``` json
4545{
4646 "require" : {
@@ -52,8 +52,9 @@ composer require chillerlan/database:dev-master
5252
5353### Manual installation
5454Download the desired version of the package from [ master] ( https://github.com/codemasher/php-database/archive/master.zip ) or
55- [ release] ( https://github.com/codemasher/php-database/releases ) and extract the contents to your project folder.
56- Point the namespace ` chillerlan/Database ` to the folder ` src ` of the package.
55+ [ release] ( https://github.com/codemasher/php-database/releases ) and extract the contents to your project folder. After that:
56+ - run ` composer install ` to install the required dependencies and generate ` /vendor/autoload.php ` .
57+ - if you use a custom autoloader, point the namespace ` chillerlan\Database ` to the folder ` src ` of the package
5758
5859Profit!
5960
0 commit comments