summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavey Shafik <me@daveyshafik.com>2017-01-10 19:42:52 -0800
committerDavey Shafik <me@daveyshafik.com>2017-01-10 19:42:52 -0800
commitf0e99896be5221a2b92060eb21faafb40794ffc9 (patch)
treec1edf1baca74ca30dd9a14837a3f93171235f04e
parent79a84640939bc9b09aad90e9565563a00baa5616 (diff)
downloadphp7-mysql-shim-f0e99896be5221a2b92060eb21faafb40794ffc9.zip
php7-mysql-shim-f0e99896be5221a2b92060eb21faafb40794ffc9.tar.gz
php7-mysql-shim-f0e99896be5221a2b92060eb21faafb40794ffc9.tar.bz2
Clarify install/usage docs
-rw-r--r--README.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/README.md b/README.md
index 5d046bd..4504143 100644
--- a/README.md
+++ b/README.md
@@ -23,11 +23,13 @@ To install, either add `dshafik/php7-mysql-shim` to your `composer.json`:
$ composer require dshafik/php7-mysql-shim
```
-or, clone/download this repo, and include `mysql.php` in your project.
+or, clone/download this repo, and include `lib/mysql.php` in your project.
## Usage
-Once the file is included, it will create `mysql_*` functions if they don't already exist. _**You may safely include the file in a PHP 5.3.6+ project**_, it will do nothing if the mysql extension is already available.
+When installed with composer, the library is included automatically.
+
+Once the `lib/mysql.php` file is included, it will create `mysql_*` functions if they don't already exist. _**You may safely include the file in a PHP 5.3.6+ project**_, it will do nothing if the mysql extension is already available.
## Caveats