Merge pull request #44 from wp-cli/explain-available-fields

Explain available fields in results

Author: gitlost

README.md

@@ -32,6 +32,19 @@ $ wp find ./
 +--------------------------------------+---------------------+-------+--------+
 ```
 
+**AVAILABLE FIELDS**
+
+These fields will be displayed by default for each installation:
+
+* version_path - Path to the version.php file.
+* version - WordPress version.
+* depth - Directory depth at which the installation was found.
+* alias - WP-CLI alias, if one is registered.
+
+These fields are optionally available:
+
+* wp_path - Path that can be passed to `--path=<path>` global parameter.
+
 **OPTIONS**
 
 	<path>

src/Find_Command.php

@@ -133,6 +133,19 @@ class Find_Command {
 	 * +--------------------------------------+---------------------+-------+--------+
 	 * ```
 	 *
+	 * ## AVAILABLE FIELDS
+	 *
+	 * These fields will be displayed by default for each installation:
+	 *
+	 * * version_path - Path to the version.php file.
+	 * * version - WordPress version.
+	 * * depth - Directory depth at which the installation was found.
+	 * * alias - WP-CLI alias, if one is registered.
+	 *
+	 * These fields are optionally available:
+	 *
+	 * * wp_path - Path that can be passed to `--path=<path>` global parameter.
+	 *
 	 * ## OPTIONS
 	 *
 	 * <path>