Skip to content

Commit 3f5c7e4

Browse files
committed
Updates docs
1 parent 025439b commit 3f5c7e4

File tree

2 files changed

+10
-14
lines changed

2 files changed

+10
-14
lines changed

.mddoc.xml.dist

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<mddoc>
22
<docpage target="README.md">
33
<section title="Recursive Require">
4-
<badge-poser type="version" />
5-
<badge-poser type="license" />
6-
<badge-travis name="CorpusPHP/RecursiveRequire" />
4+
<badge-poser type="version"/>
5+
<badge-poser type="license"/>
6+
<badge-github-action name="CorpusPHP/RecursiveRequire" workflow="CI"/>
77

88
<text>Library to Recursively Require Every PHP File in a Directory Tree</text>
99

@@ -15,13 +15,13 @@
1515
<composer-install/>
1616
</section>
1717

18-
<section title="Example">
18+
<section title="Usage">
1919
<text>Here is a simple usage example:</text>
20-
<source name="example/example.php" lang="php" />
20+
<source name="example/example.php" lang="php"/>
2121
</section>
2222

2323
<section title="Documentation">
24-
<file name="src/Loader.php" />
24+
<file name="src/Loader.php"/>
2525
</section>
2626
</section>
2727
</docpage>

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Latest Stable Version](https://poser.pugx.org/corpus/recursive-require/version)](https://packagist.org/packages/corpus/recursive-require)
44
[![License](https://poser.pugx.org/corpus/recursive-require/license)](https://packagist.org/packages/corpus/recursive-require)
5-
[![Build Status](https://travis-ci.org/CorpusPHP/RecursiveRequire.svg?branch=master)](https://travis-ci.org/CorpusPHP/RecursiveRequire)
5+
[![Build Status](https://github.com/CorpusPHP/RecursiveRequire/workflows/CI/badge.svg?)](https://github.com/CorpusPHP/RecursiveRequire/actions?query=workflow%3ACI)
66

77

88
Library to Recursively Require Every PHP File in a Directory Tree
@@ -19,7 +19,7 @@ Install the latest version with:
1919
composer require 'corpus/recursive-require'
2020
```
2121

22-
## Example
22+
## Usage
2323

2424
Here is a simple usage example:
2525

@@ -42,7 +42,7 @@ $loader();
4242
#### Method: Loader->__construct
4343

4444
```php
45-
function __construct($path)
45+
function __construct(string $path)
4646
```
4747

4848
##### Parameters:
@@ -54,15 +54,11 @@ function __construct($path)
5454
#### Method: Loader->__invoke
5555

5656
```php
57-
function __invoke([ $regex = "/\\.php$/"])
57+
function __invoke([ string $regex = "/\\.php\$/"]) : array
5858
```
5959

6060
Trigger the require's
6161

62-
##### Parameters:
63-
64-
- ***string*** `$regex`
65-
6662
##### Returns:
6763

6864
- ***array*** - The result as a map of filename to return value.

0 commit comments

Comments
 (0)