PHPackages                             voku/php-readme-helper - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. voku/php-readme-helper

ActiveLibrary

voku/php-readme-helper
======================

auto-generate your README from your code

0.6.4(3y ago)62.3k1[2 PRs](https://github.com/voku/Php-Readme-Helper/pulls)MITPHPPHP >=7.1.0

Since May 15Pushed 3mo ago1 watchersCompare

[ Source](https://github.com/voku/Php-Readme-Helper)[ Packagist](https://packagist.org/packages/voku/php-readme-helper)[ Docs](https://github.com/voku/Php-Readme-Helper)[ RSS](/packages/voku-php-readme-helper/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (2)Versions (14)Used By (0)

[![Build Status](https://camo.githubusercontent.com/1c963c2281752c283f725fc44a95de4f49fe747e9130f009dee90def6d83b7ef/68747470733a2f2f7472617669732d63692e636f6d2f766f6b752f5068702d526561646d652d48656c7065722e7376673f6272616e63683d6d6173746572)](https://travis-ci.com/voku/Php-Readme-Helper)[![Coverage Status](https://camo.githubusercontent.com/c9ab8bb27c09a590b5b3ab0c6acc84f06fd6bf3bc5c215809c5f9e55643de239/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f766f6b752f5068702d526561646d652d48656c7065722f62616467652e7376673f6272616e63683d6d6173746572)](https://coveralls.io/github/voku/Php-Readme-Helper?branch=master)[![Codacy Badge](https://camo.githubusercontent.com/d4ca3f1984fb406e2ee77cb984900cdef16c97439724d7389d6da34eba5f4adf/68747470733a2f2f6170702e636f646163792e636f6d2f70726f6a6563742f62616467652f47726164652f3230303534363736373261613434616262663262613537666261643830616631)](https://www.codacy.com/manual/voku/Php-Readme-Helper?utm_source=github.com&utm_medium=referral&utm_content=voku/Php-Readme-Helper&utm_campaign=Badge_Grade)[![Latest Stable Version](https://camo.githubusercontent.com/02f5bcda935aeca1038bb2ed060f444d4bc6e71462c61129b52f1fdcca182c92/68747470733a2f2f706f7365722e707567782e6f72672f766f6b752f5068702d526561646d652d48656c7065722f762f737461626c65)](https://packagist.org/packages/voku/php-readme-helper)[![Total Downloads](https://camo.githubusercontent.com/a77e093211e0866215adf5788aa5b393b4309f97f94b35428ef730a57c938a68/68747470733a2f2f706f7365722e707567782e6f72672f766f6b752f7068702d726561646d652d68656c7065722f646f776e6c6f616473)](https://packagist.org/packages/voku/php-readme-helper)[![License](https://camo.githubusercontent.com/abffdc551c3f73c2aebbe59c5abdc0bea3d4f98c62080d7af29f4a01970b77af/68747470733a2f2f706f7365722e707567782e6f72672f766f6b752f7068702d726561646d652d68656c7065722f6c6963656e7365)](https://packagist.org/packages/voku/php-readme-helper)[![Donate to this project using Paypal](https://camo.githubusercontent.com/0d6e4d8b50b5983a58205941b1a581b1305903393b7a39da574e3f60af3c7f5b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f70617970616c2d646f6e6174652d79656c6c6f772e737667)](https://www.paypal.me/moelleken)[![Donate to this project using Patreon](https://camo.githubusercontent.com/f9e075baad95563481d35174d43ef50757281abb6bc795d0f473fad452afa030/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f70617472656f6e2d646f6e6174652d79656c6c6f772e737667)](https://www.patreon.com/voku)

📖 PHP README Helper
===================

[](#-php-readme-helper)

Helper to auto-generate the API documentation in your README file.

### Example

[](#example)

(build/generate\_docs.php)

```
$readmeGenerator = new \voku\PhpReadmeHelper\GenerateApi();

$readmeText = ($readmeGenerator)->generate(
    __DIR__ . '/../src/voku/PhpReadmeHelper/GenerateApi.php',
    __DIR__ . '/docs/base.md'
);

file_put_contents(__DIR__ . '/../README.md', $readmeText);
```

### GenerateApi

[](#generateapi)

#### generate(string $codePath, string $baseDocFilePath, string\[\]|null $useClasses): string

[](#generatestring-codepath-string-basedocfilepath-stringnull-useclasses-string)

[↑](#voku-php-readme-class-methods)This method can generate API documentation with types from php code into your README file.

**Parameters:**

- `string $codePath Path to a file or a directory.`
- `string $baseDocFilePath Path to your base file for the README.`
- `array|null $useClasses If used, you can specify to classes, you will use.`

**Return:**

- `string Return a string with the generated README.`

---

### Support

[](#support)

For support and donations please visit [Github](https://github.com/voku/simple_html_dom/) | [Issues](https://github.com/voku/simple_html_dom/issues) | [PayPal](https://paypal.me/moelleken) | [Patreon](https://www.patreon.com/voku).

For status updates and release announcements please visit [Releases](https://github.com/voku/simple_html_dom/releases) | [Twitter](https://twitter.com/suckup_de) | [Patreon](https://www.patreon.com/voku/posts).

For professional support please contact [me](https://about.me/voku).

### Thanks

[](#thanks)

- Thanks to [GitHub](https://github.com) (Microsoft) for hosting the code and a good infrastructure including Issues-Managment, etc.
- Thanks to [IntelliJ](https://www.jetbrains.com) as they make the best IDEs for PHP and they gave me an open source license for PhpStorm!
- Thanks to [Travis CI](https://travis-ci.com/) for being the most awesome, easiest continous integration tool out there!
- Thanks to [StyleCI](https://styleci.io/) for the simple but powerfull code style check.
- Thanks to [PHPStan](https://github.com/phpstan/phpstan) && [Psalm](https://github.com/vimeo/psalm) for really great Static analysis tools and for discover bugs in the code!

###  Health Score

37

—

LowBetter than 83% of packages

Maintenance55

Moderate activity, may be stable

Popularity24

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity48

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 96.6% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~84 days

Recently: every ~189 days

Total

11

Last Release

1347d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/6456fe693db197c458272cb758bf78958bc7d3e787ccd59db4bf3cf41654316a?d=identicon)[voku](/maintainers/voku)

---

Top Contributors

[![voku](https://avatars.githubusercontent.com/u/264695?v=4)](https://github.com/voku "voku (28 commits)")[![renovate[bot]](https://avatars.githubusercontent.com/in/2740?v=4)](https://github.com/renovate[bot] "renovate[bot] (1 commits)")

---

Tags

phpreadmereadme-generatorphpreadme

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/voku-php-readme-helper/health.svg)

```
[![Health](https://phpackages.com/badges/voku-php-readme-helper/health.svg)](https://phpackages.com/packages/voku-php-readme-helper)
```

###  Alternatives

[marcocesarato/php-conventional-changelog

Generate changelogs and release notes from a project's commit messages and metadata and automate versioning with semver.org and conventionalcommits.org

2511.3M109](/packages/marcocesarato-php-conventional-changelog)[pestphp/pest-plugin-stressless

Stressless plugin for Pest

67792.6k16](/packages/pestphp-pest-plugin-stressless)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)