Skip to content

Commit

Permalink
Add docs about usage
Browse files Browse the repository at this point in the history
  • Loading branch information
wandersonwhcr committed May 8, 2021
1 parent 281ad1d commit 278c583
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@ section of `composer.json`, pointing to the latest stable version.

## Usage

The `Griffin\Harpy\Harpy::search` method use variadic parameters of `string`
representing files or directories. These directories will be recursively listed
searching for files. Each file found will be parsed searching for class
definitions.

```php
use Griffin\Harpy\Harpy;

Expand Down Expand Up @@ -62,3 +67,8 @@ array(6) {
}
*/
```

If Harpy hasn't permissions to list directories or read files, warnings will not
be raised, because it only searches for classes and not handles errors. Also,
Harpy is not a class loader, you must use tools like Composer to execute this
job.

0 comments on commit 278c583

Please sign in to comment.