Regenerate README for command split

This commit is contained in:
Daniel Bachhuber 2016-10-04 06:49:18 -07:00
parent b22d0f85c7
commit 87b192afa3
3 changed files with 40 additions and 10 deletions

View file

@ -84,26 +84,55 @@ Et voila! You've identified some of the sources of slowness.
## Using ## Using
This package implements the following commands:
### wp profile stage
Profile each stage of the WordPress load process (bootstrap, main_query, template).
~~~ ~~~
wp profile [--url=<url>] [--stage=<stage>] [--hook=<hook>] [--fields=<fields>] [--format=<format>] wp profile stage [<stage>] [--url=<url>] [--fields=<fields>] [--format=<format>]
~~~ ~~~
**OPTIONS** **OPTIONS**
[<stage>]
Drill down into a specific stage.
[--url=<url>] [--url=<url>]
Execute a request against a specified URL. Defaults to the home URL. Execute a request against a specified URL. Defaults to the home URL.
[--stage=<stage>] [--fields=<fields>]
Drill down into a specific stage. Display one or more fields.
[--format=<format>]
Render output in a particular format.
--- ---
default: table
options: options:
- bootstrap - table
- main_query - json
- template - yaml
- csv
--- ---
[--hook=<hook>]
Drill down into a specific hook.
### wp profile hook
Profile key metrics for a WordPress hook (action or filter).
~~~
wp profile hook <hook> [--url=<url>] [--fields=<fields>] [--format=<format>]
~~~
**OPTIONS**
<hook>
WordPress hook (action or filter) to profile.
[--url=<url>]
Execute a request against a specified URL. Defaults to the home URL.
[--fields=<fields>] [--fields=<fields>]
Display one or more fields. Display one or more fields.

View file

@ -17,7 +17,8 @@
}, },
"extra": { "extra": {
"commands": [ "commands": [
"profile" "profile stage",
"profile hook"
], ],
"readme": { "readme": {
"shields": [ "shields": [

View file

@ -17,7 +17,7 @@ class Command {
private static $exception_message = "Need to bail, because can't restore the hooks"; private static $exception_message = "Need to bail, because can't restore the hooks";
/** /**
* Profile each stage of the WordPress load process. * Profile each stage of the WordPress load process (bootstrap, main_query, template).
* *
* ## OPTIONS * ## OPTIONS
* *