Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
codemasher committed Nov 26, 2017
1 parent 80b76b4 commit 07270ee
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# chillerlan/database

A PHP7 SQL client and querybuilder for the most common databases.

[![version][packagist-badge]][packagist]
[![license][license-badge]][license]
[![Travis][travis-badge]][travis]
Expand All @@ -20,27 +22,25 @@
[codeclimate-badge]: https://img.shields.io/codeclimate/github/codemasher/php-database.svg
[codeclimate]: https://codeclimate.com/github/codemasher/php-database

# Requirements
# Documentation

## Requirements
- PHP 7+
- one of the supported databases, set up to work with PHP

# Supported databases
## Supported databases
- MySQL/MariaDB (native, PDO, ODBC)
- PostgreSQL (native, PDO, ODBC)
- Microsoft SQL Server (native, PDO, ODBC)
- SQLite3 (PDO)
- Firebird (PDO)
- any other database supported via PDO, ODBC or native PHP extension

# Documentation
## Installation
### Using [composer](https://getcomposer.org)

*Terminal*
```sh
composer require chillerlan/database:dev-master
```
**requires [composer](https://getcomposer.org)**

*composer.json*
### *composer.json*
(note: replace `dev-master` with a [version boundary](https://getcomposer.org/doc/articles/versions.md#summary))
```json
{
"require": {
Expand All @@ -52,8 +52,9 @@ composer require chillerlan/database:dev-master

### Manual installation
Download the desired version of the package from [master](https://github.com/codemasher/php-database/archive/master.zip) or
[release](https://github.com/codemasher/php-database/releases) and extract the contents to your project folder.
Point the namespace `chillerlan/Database` to the folder `src` of the package.
[release](https://github.com/codemasher/php-database/releases) and extract the contents to your project folder. After that:
- run `composer install` to install the required dependencies and generate `/vendor/autoload.php`.
- if you use a custom autoloader, point the namespace `chillerlan\Database` to the folder `src` of the package

Profit!

Expand Down

0 comments on commit 07270ee

Please sign in to comment.