auto-generate your README from your code

0.6.4 2022-09-01 07:45 UTC

This package is auto-updated.

Last update: 2023-05-16 07:34:56 UTC


Build Status Coverage Status Codacy Badge Latest Stable Version Total Downloads License Donate to this project using Paypal Donate to this project using Patreon


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



$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);


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

This method can generate API documentation with types from php code into your README file.


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


  • string <p>Return a string with the generated README.</p>


For support and donations please visit Github | Issues | PayPal | Patreon.

For status updates and release announcements please visit Releases | Twitter | Patreon.

For professional support please contact me.


  • Thanks to GitHub (Microsoft) for hosting the code and a good infrastructure including Issues-Managment, etc.
  • Thanks to IntelliJ as they make the best IDEs for PHP and they gave me an open source license for PhpStorm!
  • Thanks to Travis CI for being the most awesome, easiest continous integration tool out there!
  • Thanks to StyleCI for the simple but powerfull code style check.
  • Thanks to PHPStan && Psalm for really great Static analysis tools and for discover bugs in the code!