wp-cli/widget-command
2
0
Fork 0
mirror of https://hk.gh-proxy.com/https://github.com/wp-cli/profile-command.git synced 2025-08-18 06:11:20 +08:00
Code Issues Projects Packages Activity Actions

Put the long README introduction in an Overview section

Browse source
This commit is contained in:
Daniel Bachhuber 2016-08-30 07:05:50 -07:00
parent dd0f772a6b
commit ce62d52b19
4 changed files with 18 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -3,6 +3,12 @@ runcommand/profile
Quickly identify what's slow with WordPress. Quickly identify what's slow with WordPress.
[![CircleCI](https://circleci.com/gh/runcommand/profile/tree/master.svg?style=svg&circle-token=d916e588bf7c8ac469a3bd01930cf9eed886debe)](https://circleci.com/gh/runcommand/profile/tree/master)
Quick links: [Overview](#overview) | [Using](#using) | [Installing](#installing) | [Support](#support)
## Overview
`wp profile` monitors key performance indicators of the WordPress execution process to help you quickly identify points of slowness. `wp profile` monitors key performance indicators of the WordPress execution process to help you quickly identify points of slowness.
Save hours diagnosing slow WordPress sites with `wp profile`. Because you can easily run it on any server that supports WP-CLI, `wp profile` compliments Xdebug and New Relic by pointing you in the right direction for further debugging. And, because it's a WP-CLI command, using `wp profile` means you don't have to install a plugin and deal with the painful dashboard of a slow WordPress site. Save hours diagnosing slow WordPress sites with `wp profile`. Because you can easily run it on any server that supports WP-CLI, `wp profile` compliments Xdebug and New Relic by pointing you in the right direction for further debugging. And, because it's a WP-CLI command, using `wp profile` means you don't have to install a plugin and deal with the painful dashboard of a slow WordPress site.
@ -75,10 +81,6 @@ $ wp profile --hook=plugins_loaded
Et voila! You've identified some of the sources of slowness. Et voila! You've identified some of the sources of slowness.
[![CircleCI](https://circleci.com/gh/runcommand/profile/tree/master.svg?style=svg&circle-token=d916e588bf7c8ac469a3bd01930cf9eed886debe)](https://circleci.com/gh/runcommand/profile/tree/master)
Quick links: [Using](#using) | [Installing](#installing) | [Contributing](#contributing)
## Using ## Using
~~~ ~~~
@ -136,10 +138,11 @@ require:
- runcommand-profile/command.php - runcommand-profile/command.php
``` ```
## Contributing ## Support
Support (bug reports, feature requests, and general usage questions) is available to those with an active runcommand subscription. Support (bug reports, feature requests, and general usage questions) is available to those with an active runcommand subscription.
Send an email to [support@runcommand.io](mailto:support@runcommand.io). Send an email to [support@runcommand.io](mailto:support@runcommand.io).
*This README.md is generated dynamically from the project's codebase using `wp scaffold package-readme` ([doc](https://github.com/wp-cli/scaffold-package-command#wp-scaffold-package-readme)). To suggest changes, please submit a pull request against the corresponding part of the codebase.* *This README.md is generated dynamically from the project's codebase using `wp scaffold package-readme` ([doc](https://github.com/wp-cli/scaffold-package-command#wp-scaffold-package-readme)). To suggest changes, please submit a pull request against the corresponding part of the codebase.*

0
bin/readme/package-description-post.md → bin/readme/overview-body.md
View file

0
bin/readme/contributing-body.md → bin/readme/support-body.md
View file

14
composer.json
View file

@ -22,14 +22,20 @@
"shields": [ "shields": [
"[![CircleCI](https://circleci.com/gh/runcommand/profile/tree/master.svg?style=svg&circle-token=d916e588bf7c8ac469a3bd01930cf9eed886debe)](https://circleci.com/gh/runcommand/profile/tree/master)" "[![CircleCI](https://circleci.com/gh/runcommand/profile/tree/master.svg?style=svg&circle-token=d916e588bf7c8ac469a3bd01930cf9eed886debe)](https://circleci.com/gh/runcommand/profile/tree/master)"
], ],
"package_description": { "sections": [
"post": "bin/readme/package-description-post.md" "Overview",
"Using",
"Installing",
"Support"
],
"overview": {
"post": "bin/readme/overview-body.md"
}, },
"installing": { "installing": {
"body": "bin/readme/installing-body.md" "body": "bin/readme/installing-body.md"
}, },
"contributing": { "support": {
"body": "bin/readme/contributing-body.md" "body": "bin/readme/support-body.md"
} }
} }
} }