This package is abandoned and no longer maintained. No replacement package was suggested.

PHP Composter action to regenerate the README.md file (pre-commit + post-commit).

Installs: 1 376

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 5

Forks: 1

Open Issues: 0


v2.0.1 2018-09-14 14:38 UTC

This package is auto-updated.

Last update: 2023-11-10 15:03:00 UTC


PHP Composter action to regenerate the README.md file (precommit).

Quick links: Installing | Using | Contributing | Support


Just add as a development requirement to your composer.json, and it should work automagically:

composer require --dev wp-cli/regenerate-readme


It should just work when you git commit.


We appreciate you taking the initiative to contribute to this project.

Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.

For a more thorough introduction, check out WP-CLI's guide to contributing. This package follows those policy and guidelines.

Reporting a bug

Think you’ve found a bug? We’d love for you to help us get it fixed.

Before you create a new issue, you should search existing issues to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.

Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please create a new issue. Include as much detail as you can, and clear steps to reproduce if possible. For more guidance, review our bug report documentation.

Creating a pull request

Want to contribute a new feature? Please first open a new issue to discuss whether the feature is a good fit for the project.

Once you've decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it's a pleasant experience. See "Setting up" for details specific to working on this package locally.


Github issues aren't for general support questions, but there are other venues you can try: http://wp-cli.org/#support