eric
/
retrorsum
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme

This commit is contained in:
R. Eric Wheeler 2017-02-02 17:59:09 -08:00
parent 4b632ba7ba
commit d13c79f00f
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -6,20 +6,22 @@ This came about because I was thinking of how I could find the base directory of
I wanted to find a way to find the base directory of an app from a class.
At the moment it does not work if the path is a symlink.
## Usage
```php
use Sikofitt\Retrorsum\Finder;
$finder = new Finder('composer.json');
$finder = new Finder('autoload.php');
define('BASE_DIR', (string)$finder);
define('BASE_DIR', dirname((string)$finder));
```
or
```php
define('BASE_DIR', (string)(new Finder('composer.json')));
define('BASE_DIR', dirname((string)(new Finder('composer.json'))));
```
Although this could set BASE_DIR as an empty string if it found nothing.
@ -28,7 +30,7 @@ Although this could set BASE_DIR as an empty string if it found nothing.
$finder = new Finder('composer.json');
if(true === $finder->isFound())
{
define('BASE_DIR', $finder->getPath());
define('BASE_DIR', dirname($finder->getPath()));
} else {
// Whatever your other method would be.
}