From ce62d52b19697da12d1b6d731fc3f1a80ae3c6cc Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Tue, 30 Aug 2016 07:05:50 -0700 Subject: [PATCH] Put the long README introduction in an Overview section --- README.md | 13 ++++++++----- ...ackage-description-post.md => overview-body.md} | 0 .../{contributing-body.md => support-body.md} | 0 composer.json | 14 ++++++++++---- 4 files changed, 18 insertions(+), 9 deletions(-) rename bin/readme/{package-description-post.md => overview-body.md} (100%) rename bin/readme/{contributing-body.md => support-body.md} (100%) diff --git a/README.md b/README.md index f249d57..2ea21b0 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,12 @@ runcommand/profile 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. 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. -[![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 ~~~ @@ -136,10 +138,11 @@ require: - runcommand-profile/command.php ``` -## Contributing +## Support 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). + *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.* diff --git a/bin/readme/package-description-post.md b/bin/readme/overview-body.md similarity index 100% rename from bin/readme/package-description-post.md rename to bin/readme/overview-body.md diff --git a/bin/readme/contributing-body.md b/bin/readme/support-body.md similarity index 100% rename from bin/readme/contributing-body.md rename to bin/readme/support-body.md diff --git a/composer.json b/composer.json index 0aac729..58210d3 100644 --- a/composer.json +++ b/composer.json @@ -22,14 +22,20 @@ "shields": [ "[![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": { - "post": "bin/readme/package-description-post.md" + "sections": [ + "Overview", + "Using", + "Installing", + "Support" + ], + "overview": { + "post": "bin/readme/overview-body.md" }, "installing": { "body": "bin/readme/installing-body.md" }, - "contributing": { - "body": "bin/readme/contributing-body.md" + "support": { + "body": "bin/readme/support-body.md" } } }