From f0e99896be5221a2b92060eb21faafb40794ffc9 Mon Sep 17 00:00:00 2001 From: Davey Shafik Date: Tue, 10 Jan 2017 19:42:52 -0800 Subject: Clarify install/usage docs --- README.md | 6 ++++-- 1 file 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 -- cgit v1.1