feat(README): update project description

- Change the project description from a PHP package template repository to a list of release worker collections for symplify/monorepo-builder.
guanguans · Jul 17, 2023 · 195c872 · 195c872
1 parent c47abf4
commit 195c872
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 74 deletions.
diff --git a/README-zh_CN.md b/README-zh_CN.md
@@ -2,7 +2,7 @@
 
 [简体中文](README-zh_CN.md) | [ENGLISH](README.md)
 
-> 一个 PHP 软件包模板存储库。- A PHP package template repository.
+> List of release worker collections for [symplify/monorepo-builder](https://github.com/symplify/monorepo-builder).
 
 [![tests](https://github.com/guanguans/monorepo-builder-worker/workflows/tests/badge.svg)](https://github.com/guanguans/monorepo-builder-worker/actions)
 [![check & fix styling](https://github.com/guanguans/monorepo-builder-worker/actions/workflows/php-cs-fixer.yml/badge.svg)](https://github.com/guanguans/monorepo-builder-worker/actions)
@@ -15,52 +15,21 @@
 [![Total Downloads](https://poser.pugx.org/guanguans/monorepo-builder-worker/downloads)](https://packagist.org/packages/guanguans/monorepo-builder-worker)
 [![License](https://poser.pugx.org/guanguans/monorepo-builder-worker/license)](https://packagist.org/packages/guanguans/monorepo-builder-worker)
 
-## 功能
-
-* 集成了 [brainmaestro/composer-git-hooks](https://github.com/BrainMaestro/composer-git-hooks) - git 钩子
-* 集成了 [brianium/paratest](https://github.com/paratestphp/paratest) - PHPUnit 的并行测试
-* 集成了 [codedungeon/phpunit-result-printer](https://github.com/mikeerickson/phpunit-pretty-result-printer) - PHPUnit 漂亮的打印结果
-* 集成了 [dg/bypass-finals](https://github.com/rdohms/dg/bypass-finals) - 单元测试辅助包
-* 集成了 [dms/phpunit-arraysubset-asserts](https://github.com/rdohms/phpunit-arraysubset-asserts) - 单元测试辅助包
-* 集成了 [sebastianbergmann/phpunit](https://github.com/sebastianbergmann/phpunit) - 单元测试
-* 集成了 [bovigo/vfsStream](https://github.com/bovigo/vfsStream) - 单元测试辅助包
-* 集成了 [mockery/mockery](https://github.com/mockery/mockery) - mock
-* 集成了 [Nyholm/NSA](https://github.com/Nyholm/NSA) - 单元测试辅助包
-* 集成了 [phpbench/phpbench](https://github.com/phpbench/phpbench) - 基准测试
-* 集成了 [FriendsOfPHP/PHP-CS-Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) - 编码规范检查
-* 集成了 [johnkary/phpunit-speedtrap](https://github.com/johnkary/phpunit-speedtrap) - 报告 PHPUnit 测试中运行缓慢的测试
-* 集成了 [overtrue/phplint](https://github.com/overtrue/phplint) - 语法检查
-* 集成了 [symplify/monorepo-builder](https://github.com/symplify/monorepo-builder) - Monorepo
-* 集成了 [vimeo/psalm](https://github.com/vimeo/psalm) - 静态检查
-* 集成了 [lint-md/lint-md](https://github.com/lint-md/lint-md) - markdown 语法检查
-* 集成了 [povils/phpmnd](https://github.com/povils/phpmnd) - PHP 幻数检测器
-* 集成了 ...
-* 自带 IDE 帮助文件
-* 自带 `github/pages` docsify [文档网站](https://guanguans.github.io/monorepo-builder-worker/)
-* 自带常用徽章图标
-* 自带中英文 `README.md` 文件
-
 ## 环境要求
 
-* PHP >= 7.2
+* PHP >= 7.3
 
 ## 安装
 
 ```bash
-composer require guanguans/monorepo-builder-worker --prefer-dist -vvv
+composer require guanguans/monorepo-builder-worker --prefer-dist --dev -v
 ```
 
 ## 使用
 
-1. 执行 `$ git clone https://github.com/guanguans/monorepo-builder-worker.git`
-2. 替换 `guanguans/monorepo-builder-worker` -> `vendorName/package-name`
-3. 替换 `Guanguans\\MonorepoBuilderWorker` -> `VendorName\\PackageName`
-4. 替换 `Guanguans\MonorepoBuilderWorker` -> `VendorName\PackageName`
-5. 替换 `GuanguansPackageSkeletonUpdateHelper` -> `VendorNamePackageNameUpdateHelper`
-6. 替换 `monorepo-builder-worker` -> `your repository name`
-7. 替换 `ityaozm@gmail.com` -> `your email`
-8. 执行 `$ composer install && composer dumpautoload`
-9. 执行 `$ rm .git/ && git init && git add . && git commit -m 'Build the basic skeleton'`
+```php
+// todo
+```
 
 ## 测试
 

diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 [简体中文](README-zh_CN.md) | [ENGLISH](README.md)
 
-> A PHP package template repository. - 一个 PHP 软件包模板存储库。
+> List of release worker collections for [symplify/monorepo-builder](https://github.com/symplify/monorepo-builder).
 
 [![tests](https://github.com/guanguans/monorepo-builder-worker/workflows/tests/badge.svg)](https://github.com/guanguans/monorepo-builder-worker/actions)
 [![check & fix styling](https://github.com/guanguans/monorepo-builder-worker/actions/workflows/php-cs-fixer.yml/badge.svg)](https://github.com/guanguans/monorepo-builder-worker/actions)
@@ -15,52 +15,21 @@
 [![Total Downloads](https://poser.pugx.org/guanguans/monorepo-builder-worker/downloads)](https://packagist.org/packages/guanguans/monorepo-builder-worker)
 [![License](https://poser.pugx.org/guanguans/monorepo-builder-worker/license)](https://packagist.org/packages/guanguans/monorepo-builder-worker)
 
-## Features
-
-* Integrated [brainmaestro/composer-git-hooks](https://github.com/BrainMaestro/composer-git-hooks) - Git hooks
-* Integrated [brianium/paratest](https://github.com/paratestphp/paratest) - Parallel testing for PHPUnit
-* Integrated [codedungeon/phpunit-result-printer](https://github.com/mikeerickson/phpunit-pretty-result-printer) - PHPUnit Pretty Result Printer
-* Integrated [dg/bypass-finals](https://github.com/rdohms/dg/bypass-finals) - Unit test assistant package
-* Integrated [dms/phpunit-arraysubset-asserts](https://github.com/rdohms/phpunit-arraysubset-asserts) - Unit test assistant package
-* Integrated [sebastianbergmann/phpunit](https://github.com/sebastianbergmann/phpunit) - Unit test
-* Integrated [bovigo/vfsStream](https://github.com/bovigo/vfsStream) - Unit test assistant package
-* Integrated [mockery/mockery](https://github.com/mockery/mockery) - Mock
-* Integrated [Nyholm/NSA](https://github.com/Nyholm/NSA) - Unit test assistant package
-* Integrated [phpbench/phpbench](https://github.com/phpbench/phpbench) - Benchmarks  
-* Integrated [FriendsOfPHP/PHP-CS-Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) - Coding standard check
-* Integrated [johnkary/phpunit-speedtrap](https://github.com/johnkary/phpunit-speedtrap) - Reports on slow-running tests in your PHPUnit test suite
-* Integrated [overtrue/phplint](https://github.com/overtrue/phplint) - Grammar check
-* Integrated [symplify/monorepo-builder](https://github.com/symplify/monorepo-builder) - Monorepo
-* Integrated [vimeo/psalm](https://github.com/vimeo/psalm) - Static check
-* Integrated [lint-md/lint-md](https://github.com/lint-md/lint-md) - Markdown grammar check
-* Integrated [povils/phpmnd](https://github.com/povils/phpmnd) - PHP Magic Number Detector
-* Integrated ...
-* With IDE helper file
-* With `github/pages` docsify [documentation site](https://guanguans.github.io/monorepo-builder-worker/)
-* With common badge icons
-* With Chinese and English `README.md` file
-
 ## Requirement
 
-* PHP >= 7.2
+* PHP >= 7.3
 
 ## Installation
 
 ```bash
-composer require guanguans/monorepo-builder-worker --prefer-dist -vvv
+composer require guanguans/monorepo-builder-worker --prefer-dist --dev -v
 ```
 
 ## Usage
 
-1. execute `$ git clone https://github.com/guanguans/monorepo-builder-worker.git`
-2. replace `guanguans/monorepo-builder-worker` -> `vendorName/package-name`
-3. replace `Guanguans\\MonorepoBuilderWorker` -> `VendorName\\PackageName`
-4. replace `Guanguans\MonorepoBuilderWorker` -> `VendorName\PackageName`
-5. replace `GuanguansPackageSkeletonUpdateHelper` -> `VendorNamePackageNameUpdateHelper`
-6. replace `monorepo-builder-worker` -> `your repository name`
-7. replace `ityaozm@gmail.com` -> `your email`
-8. execute `$ composer install && composer dumpautoload`  
-9. execute `$ rm .git/ && git init && git add . && git commit -m 'Build the basic skeleton'`
+```php
+// todo
+```
 
 ## Testing