PHPackages                             ph-7/php-readme-generator-file - 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. [CLI & Console](/categories/cli)
4. /
5. ph-7/php-readme-generator-file

ActiveProject[CLI & Console](/categories/cli)

ph-7/php-readme-generator-file
==============================

A simple way to generate a GitHub README file

v1.2.4(4y ago)12136MITPHPPHP >=8.0.0

Since Oct 24Pushed 3y ago1 watchersCompare

[ Source](https://github.com/pH-7/github-readme-generator-cli)[ Packagist](https://packagist.org/packages/ph-7/php-readme-generator-file)[ Docs](https://pierrehenry.be)[ RSS](/packages/ph-7-php-readme-generator-file/feed)WikiDiscussions main Synced today

READMEChangelog (8)Dependencies (6)Versions (9)Used By (0)

README Generator 🚀
==================

[](#readme-generator-)

### Simplest way to generate SEO-optimized GitHub README

[](#simplest-way-to-generate-seo-optimized-github-readme)

**📄 PHP README File Generator**, to generate easily beautiful (and SEO-friendly) GitHub README files on the fly 🚀

- NEW [v1.2.0](https://github.com/pH-7/github-readme-generator-cli/releases/tag/v1.2.0): Default values are pre-selected from the information already present in the `composer.json` file. > `github-readme-generator` reads `composer.json` info and suggest the default values during the creation of your `README.md` file ✨

1. [Requirement](#-requirement)
2. [Setup](#%EF%B8%8F-setup)
3. [Me Coding It](#tv-video)
4. [About Me](#-about-me)
5. [License](#%EF%B8%8F-license)

📙 Requirement
-------------

[](#-requirement)

- Make sure you have [PHP 8.0](https://www.php.net/releases/8_0_0.php) or a higher version installed.

⚙️ Setup
--------

[](#️-setup)

- Install Composer v2 or higher ()
- Install the dependencies with composer as below

    ```
    composer install
    ```
- Update the permissions of the `generate` bash file located in the root directory

    ```
    chmod u+x ./generate

    ```
- Run the script, and follow the instruction shown. Enjoy 😺

    ```
    ./generate
    ```

[![GitHub README File Generator CLI](php-readme-generator-cli-sample.png)](php-readme-generator-cli-sample.png)

📺 Video
-------

[](#tv-video)

[![Watch the video](https://camo.githubusercontent.com/7bc2eea90cb8841e97ce3a46b52c9ee450b0336015da620c6fac7786668c2065/68747470733a2f2f69312e7974696d672e636f6d2f76692f44734a52476c3379304b492f736464656661756c742e6a7067)](https://www.youtube.com/watch?v=DsJRGl3y0KI)

👉 **[Click here to watch on YouTube](https://www.youtube.com/watch?v=DsJRGl3y0KI)**

🤠 About Me
----------

[](#-about-me)

[![Pierre-Henry Soria](https://camo.githubusercontent.com/2e624b95003073bd56ecb43792155201b96f2e1d11bab1218e2215b6238c6ac2/68747470733a2f2f732e67726176617461722e636f6d2f6176617461722f61323130666536313235336334336338363964373165616564306539303134393f733d323030)](https://ph7.me "Pierre-Henry Soria personal website")

[![@phenrysay](https://camo.githubusercontent.com/9ebce40b5dc8ca37584b018fd5b5941319d135117ef1fb2330f4aa95877e79f5/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f547769747465722d3144413146323f7374796c653d666f722d7468652d6261646765266c6f676f3d74776974746572266c6f676f436f6c6f723d7768697465)](https://twitter.com/phenrysay) [![pH-7](https://camo.githubusercontent.com/4fcd516e2fde608afc9ddd1330de295d23981c27a9b9d695f8abe51f70a1efc5/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4769744875622d3130303030303f7374796c653d666f722d7468652d6261646765266c6f676f3d676974687562266c6f676f436f6c6f723d7768697465)](https://github.com/pH-7)

**[Pierre-Henry Soria](https://ph7.me)**, a highly passionate, zen & pragmatic software engineer 😊

You can keep in touch with me at: *hi \[AT\] pH7 {D0T} me* 📮

⚖️ License
----------

[](#️-license)

This **PHP README Generator CLI script** is generously distributed under the *[MIT](https://opensource.org/licenses/MIT)*.

###  Health Score

29

—

LowBetter than 60% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity15

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor1

Top contributor holds 99.2% 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 ~17 days

Recently: every ~28 days

Total

8

Last Release

1539d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/b6d95da236687f1dca4f7d70d60037c70ef217120ea195df23a39a412ba594e0?d=identicon)[ph-7](/maintainers/ph-7)

---

Top Contributors

[![pH-7](https://avatars.githubusercontent.com/u/1325411?v=4)](https://github.com/pH-7 "pH-7 (119 commits)")[![rilysh](https://avatars.githubusercontent.com/u/71683721?v=4)](https://github.com/rilysh "rilysh (1 commits)")

---

Tags

generatorgithub-readmegithub-readme-generatormd-templatereadmereadme-generatorreadme-markdown-generatorreadme-md-generatorreadme-templateclimdreadmegithub-readmereadme md generatormd templatemd generatorreadme templatereadme generatorgenerate readme

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/ph-7-php-readme-generator-file/health.svg)

```
[![Health](https://phpackages.com/badges/ph-7-php-readme-generator-file/health.svg)](https://phpackages.com/packages/ph-7-php-readme-generator-file)
```

###  Alternatives

[pantheon-systems/terminus

A command line interface for Pantheon

3391.5M13](/packages/pantheon-systems-terminus)[acmephp/acmephp

Let's Encrypt client written in PHP

649155.1k](/packages/acmephp-acmephp)[laminas/laminas-cli

Command-line interface for Laminas projects

563.7M54](/packages/laminas-laminas-cli)[mahocommerce/maho

Free and open source ecommerce platform, created in 2024 on the M1 platform, PHP 8.3+

1322.1k12](/packages/mahocommerce-maho)

PHPackages © 2026

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