包简介

A simple way to generate a GitHub README file

README 文档

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: 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 ✨

Requirement
Setup
Me Coding It
About Me
License

📙 Requirement

Make sure you have PHP 8.0 or a higher version installed.

⚙️ Setup

Install Composer v2 or higher (https://getcomposer.org)
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
```

📺 Video

👉 Click here to watch on YouTube

🤠 About Me

Pierre-Henry Soria, a highly passionate, zen & pragmatic software engineer 😊

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

⚖️ License

This PHP README Generator CLI script is generously distributed under the MIT.

ph-7/php-readme-generator-file 适用场景与选型建议

ph-7/php-readme-generator-file 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 13 次下载、GitHub Stars 达 12，最近一次更新时间为 2021 年 10 月 31 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「cli」「md」「readme」「readme md generator」「md template」「md generator」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 ph-7/php-readme-generator-file 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 ph-7/php-readme-generator-file 我们能提供哪些服务？

定制开发 / 二次开发

基于 ph-7/php-readme-generator-file 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发