PHPackages                             tomrf/readme-gen - 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. [Parsing & Serialization](/categories/parsing)
4. /
5. tomrf/readme-gen

ActiveLibrary[Parsing & Serialization](/categories/parsing)

tomrf/readme-gen
================

generates readme with public api documentation for php packages

0.0.9(3y ago)1385MITPHPPHP ^8.0

Since Jun 15Pushed 3y ago1 watchersCompare

[ Source](https://github.com/tomrf/readme-gen)[ Packagist](https://packagist.org/packages/tomrf/readme-gen)[ Docs](http://github.com/tomrf/readme-gen)[ RSS](/packages/tomrf-readme-gen/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (7)Versions (10)Used By (5)

readme-gen - generates readme with public api documentation for php packages
============================================================================

[](#readme-gen---generates-readme-with-public-api-documentation-for-php-packages)

[![PHP Version Require](https://camo.githubusercontent.com/950529dc6419753b632abf1fd9c0243384529d1ca5c2e8580ed096490ea5133a/687474703a2f2f706f7365722e707567782e6f72672f746f6d72662f726561646d652d67656e2f726571756972652f7068703f7374796c653d666c61742d737175617265)](https://packagist.org/packages/tomrf/readme-gen) [![Latest Stable Version](https://camo.githubusercontent.com/c69397bf103b46942de64e919d7cf757e93d5812b504d9c5330a742ecd56b6a1/687474703a2f2f706f7365722e707567782e6f72672f746f6d72662f726561646d652d67656e2f763f7374796c653d666c61742d737175617265)](https://packagist.org/packages/tomrf/readme-gen) [![License](https://camo.githubusercontent.com/d424ebeb322060a2a117988d57b56a78f502fd01c4a5b0a30ee01eb2cb3250d2/687474703a2f2f706f7365722e707567782e6f72672f746f6d72662f726561646d652d67656e2f6c6963656e73653f7374796c653d666c61742d737175617265)](https://packagist.org/packages/tomrf/readme-gen)

Automatically generates a 📚 README file with public API documentation for a PHP package, based on docblocks and package information from composer.json

Included formatters:

- Markdown

📔 [Go to documentation](#documentation)

Installation
------------

[](#installation)

Installation via composer:

```
composer require tomrf/readme-gen
```

Usage
-----

[](#usage)

```
$readmeGen = new \Tomrf\ReadmeGen\ReadmeGen('.'); // path to project directory

echo $readmeGen->generate(
    new Tomrf\ReadmeGen\Formatter\MarkdownFormatter(
        \phpDocumentor\Reflection\DocBlockFactory::createInstance(),
        new \phpDocumentor\Reflection\Types\ContextFactory()
    ),
    'resources/template.md'
);
```

Testing
-------

[](#testing)

```
composer test
```

License
-------

[](#license)

This project is released under the MIT License (MIT). See [LICENSE](LICENSE) for more information.

Documentation
-------------

[](#documentation)

- [Tomrf\\ReadmeGen\\ReadmeGen](#-tomrfreadmegenreadmegenclass)
    - [\_\_construct](#__construct)
    - [generate](#generate)

---

### 📂 Tomrf\\ReadmeGen\\ReadmeGen::class

[](#-tomrfreadmegenreadmegenclass)

ReadmeGen.

Very much a work in progress.

#### \_\_construct()

[](#__construct)

```
public function __construct(
    string $projectRoot
): void
```

#### generate()

[](#generate)

```
public function generate(
    Tomrf\ReadmeGen\Interface\ReadmeFormatterInterface $formatter,
    string $templateFilename
): string
```

---

*Generated 2022-06-15T22:33:50+02:00 using 📚[tomrf/readme-gen](https://packagist.org/packages/tomrf/readme-gen)*

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity11

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity48

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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 ~18 days

Recently: every ~37 days

Total

9

Last Release

1283d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/c2113e52873316a5ad6f705f08f4218b2ee8c4348b0c693bb87bd9359908d23f?d=identicon)[tom@upnode.no](/maintainers/tom@upnode.no)

---

Top Contributors

[![tomrf](https://avatars.githubusercontent.com/u/1669009?v=4)](https://github.com/tomrf "tomrf (25 commits)")

---

Tags

documentationdocumentation-generationdocumentation-generatormarkdownphpreadmereadme-generatorreadme-mddocumentationmarkdownreadmeREADME.md

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/tomrf-readme-gen/health.svg)

```
[![Health](https://phpackages.com/badges/tomrf-readme-gen/health.svg)](https://phpackages.com/packages/tomrf-readme-gen)
```

###  Alternatives

[justinwalsh/daux.io

Documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly

4.6k38.1k1](/packages/justinwalsh-dauxio)[daux/daux.io

Documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly

825191.0k1](/packages/daux-dauxio)[wpreadme2markdown/wpreadme2markdown

Convert WordPress Plugin readme.txt to Markdown

9564.6k4](/packages/wpreadme2markdown-wpreadme2markdown)[bookdown/bookdown

Provides DocBook-like rendering of Markdown files.

8257.6k16](/packages/bookdown-bookdown)[dniccum/nova-documentation

A Laravel Nova tool that allows you to add markdown-based documentation to your administrator's dashboard.

37116.4k](/packages/dniccum-nova-documentation)[wpreadme2markdown/wp2md

CLI tool for converting WordPress Plugin readme.txt to Markdown

1961.7k4](/packages/wpreadme2markdown-wp2md)

PHPackages © 2026

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