update readme (#27)

Author: richardW8k

README.md

@@ -3,6 +3,8 @@ Gravity Forms CLI Add-On
 
 The Gravity Forms CLI Add-On allows WP-CLI users to manage installation, forms and entries on the command line.
 
+[Documentation](https://docs.gravityforms.com/category/add-ons-gravity-forms/wp-cli-add-on/)
+
 Video demos:
 
 [Form Management](https://www.youtube.com/watch?v=LO3fLW6SWk0])
@@ -12,17 +14,17 @@ Video demos:
 Getting started
 ---------------
 
-*   wp help gf
-*   wp help gf form
-*   wp help gf field
-*   wp help gf entry
-*   wp gf license
-*   wp help gf tool
+*   `wp help gf`
+*   `wp help gf form`
+*   `wp help gf field`
+*   `wp help gf entry`
+*   `wp gf license`
+*   `wp help gf tool`
 
 Form Management
 ---------------
 
-wp gf form [command]
+`wp gf form [command]`
 
 Commands:
 
@@ -39,8 +41,8 @@ Commands:
 Field Management
 ----------------
 
-* wp gf form field [command]
-* wp gf field [command] (alias)
+* `wp gf form field [command]`
+* `wp gf field [command]` (alias)
 
 Commands:
 
@@ -55,8 +57,8 @@ Commands:
 Notification Management
 -----------------------
 
-* wp gf form notification [command]
-* wp gf notification [command] (alias)
+* `wp gf form notification [command]`
+* `wp gf notification [command]` (alias)
 
 Commands:
 
@@ -71,7 +73,7 @@ Commands:
 Entry Management
 ----------------
 
-wp gf entry [command]
+`wp gf entry [command]`
 
 Commands:
 
@@ -88,7 +90,7 @@ Commands:
 Entry Notifications
 -------------------
 
-wp gf entry notification [command]
+`wp gf entry notification [command]`
 
 Commands:
 
@@ -98,7 +100,7 @@ Commands:
 License Management
 -------------------
 
-wp gf license [command]
+`wp gf license [command]`
 
 Commands:
 
@@ -109,7 +111,7 @@ Commands:
 Misc Tools
 ----------
 
-wp gf tool [command]
+`wp gf tool [command]`
 
 Commands:
 
@@ -125,35 +127,35 @@ The above commands all require Gravity Forms to be installed. However, if Gravit
 
 The install command will download and install the latest version Gravity Forms and then run the database setup. The license key will be saved in the plugin settings.
 
-A valid license key is required either in the GF_LICENSE_KEY constant or the --key option.
+A valid license key is required either in the `GF_LICENSE_KEY` constant or the `--key` option.
 
 Examples:
 
-* wp gf install -key=xxxxx
-* wp gf install -key=xxxxx --activate
-* wp gf install gravityformspolls -key=xxxxx
-* wp gf install gravityformsquiz -key=xxxxx
+* `wp gf install --key=xxxxx`
+* `wp gf install --key=xxxxx --activate`
+* `wp gf install gravityformspolls --key=xxxxx`
+* `wp gf install gravityformsquiz --key=xxxxx`
 
-Once installed, the database can be set up or upgraded separately using the setup command. The command will not re-run the setup unless the --force flag is set.
+Once installed, the database can be set up or upgraded separately using the setup command. The command will not re-run the setup unless the `--force` flag is set.
 
 Examples:
 
-* wp gf setup
-* wp gf setup --force
+* `wp gf setup`
+* `wp gf setup --force`
 
 Gravity Forms and add-ons can be updated using the update command.
 
 Examples:
 
-* wp gf update
-* wp gf update gravityformspolls
+* `wp gf update`
+* `wp gf update gravityformspolls`
 
 Check the current version using the version command.
 
 Examples:
 
-* wp gf version
-* wp gf version gravityformspolls
+* `wp gf version`
+* `wp gf version gravityformspolls`
 
 
 Requirements
@@ -167,6 +169,6 @@ Requirements
 Support
 -------
 
-If you find anything that needs fixing, or if you have any ideas for improvements, please open a support ticket:
-https://www.gravityforms.com/open-support-ticket/
+If you find anything that needs fixing please open a support ticket at https://www.gravityforms.com/open-support-ticket/
 
+If you have any ideas for improvements please submit your idea at https://www.gravityforms.com/gravity-forms-roadmap/

readme.txt

@@ -13,6 +13,8 @@ Manage Gravity Forms on the command line.
 
 The Gravity Forms CLI Add-On allows WP-CLI users to manage forms and entries and more on the command line.
 
+[Documentation](https://docs.gravityforms.com/category/add-ons-gravity-forms/wp-cli-add-on/)
+
 Form Management
 [youtube https://www.youtube.com/watch?v=LO3fLW6SWk0]
 
@@ -21,20 +23,20 @@ Entry Management
 
 = Getting started =
 
-*   wp help gf
-*   wp help gf form
-*   wp help gf form field
-*   wp help gf form notification
-*   wp help gf entry
-*   wp help gf entry notification
-*   wp help gf install
-*   wp help gf setup
-*   wp help gf license
-*   wp help gf tool
+*   `wp help gf`
+*   `wp help gf form`
+*   `wp help gf form field`
+*   `wp help gf form notification`
+*   `wp help gf entry`
+*   `wp help gf entry notification`
+*   `wp help gf install`
+*   `wp help gf setup`
+*   `wp help gf license`
+*   `wp help gf tool`
 
 = Form Management =
 
-wp gf form [command]
+`wp gf form [command]`
 
 Commands:
 
@@ -50,8 +52,8 @@ Commands:
 
 = Field Management =
 
-* wp gf form field [command]
-* wp gf field [command] (alias)
+* `wp gf form field [command]`
+* `wp gf field [command]` (alias)
 
 Commands:
 
@@ -65,8 +67,8 @@ Commands:
 
 = Notification Management =
 
-* wp gf form notification [command]
-* wp gf notification [command] (alias)
+* `wp gf form notification [command]`
+* `wp gf notification [command]` (alias)
 
 Commands:
 
@@ -80,7 +82,7 @@ Commands:
 
 = Entry Management =
 
-wp gf entry [command]
+`wp gf entry [command]`
 
 Commands:
 
@@ -96,7 +98,7 @@ Commands:
 
 = Entry Notifications =
 
-wp gf entry notification [command]
+`wp gf entry notification [command]`
 
 Commands:
 
@@ -105,7 +107,7 @@ Commands:
 
 = License Management =
 
-wp gf license [command]
+`wp gf license [command]`
 
 Commands:
 
@@ -114,7 +116,7 @@ Commands:
 
 = Misc Tools =
 
-wp gf tool [command]
+`wp gf tool [command]`
 
 Commands:
 
@@ -129,36 +131,36 @@ The above commands all require Gravity Forms to be installed. However, if Gravit
 
 The install command will download and install the latest version Gravity Forms available for auto-update and then run the database setup. The license key will be saved in the plugin settings.
 
-A valid license key is required either in the GF_LICENSE_KEY constant or the --key option.
+A valid license key is required either in the `GF_LICENSE_KEY` constant or the `--key` option.
 
 Examples:
 
-* wp gf install -key=xxxxx
-* wp gf install -key=xxxxx --activate
-* wp gf install gravityformspolls -key=xxxxx
-* wp gf install gravityformsquiz -key=xxxxx
+* `wp gf install --key=xxxxx`
+* `wp gf install --key=xxxxx --activate`
+* `wp gf install gravityformspolls --key=xxxxx`
+* `wp gf install gravityformsquiz --key=xxxxx`
 
-Once installed, the database can be set up or upgraded separately using the setup command. The command will not re-run the setup unless the --force flag is set.
+Once installed, the database can be set up or upgraded separately using the setup command. The command will not re-run the setup unless the `--force` flag is set.
 
 Examples:
 
-* wp gf setup
-* wp gf setup --force
+* `wp gf setup`
+* `wp gf setup --force`
 
 Gravity Forms and official add-ons can be updated using the update command.
 
 Examples:
 
-* wp gf update
-* wp gf update gravityformspolls
+* `wp gf update`
+* `wp gf update gravityformspolls`
 
 
 Check the current version using the version command.
 
 Examples:
 
-* wp gf version
-* wp gf version gravityformspolls
+* `wp gf version`
+* `wp gf version gravityformspolls`
 
 
 = Requirements =
@@ -169,12 +171,14 @@ Examples:
 
 = Support =
 
-If you find any that needs fixing, or if you have any ideas for improvements, please submit a support ticket:
-https://www.gravityforms.com/open-support-ticket/
+If you find anything that needs fixing please open a support ticket at https://www.gravityforms.com/open-support-ticket/
 
+If you have any ideas for improvements please submit your idea at https://www.gravityforms.com/gravity-forms-roadmap/
 
 == Installation ==
 
+`wp plugin install gravityformscli --activate` or
+
 1.  Download the zipped file.
 1.  Extract and upload the contents of the folder to /wp-contents/plugins/ folder
 1.  Go to the Plugin management page of WordPress admin section and enable the 'Gravity Forms CLI' plugin
@@ -183,44 +187,44 @@ https://www.gravityforms.com/open-support-ticket/
 
 = 1.2 =
 - Updated Gravity API domain.
-- Updated the ids format of the entry list command to support the page-size and offset args. Credit: Ulrich Pogson.
-- Updated the form export command to support the optional filename arg e.g. wp gf form export 1 --filename=testing.json. Credit: Timothy Decker.
-- Fixed an issue where the install command could not network activate plugins.
-- Fixed an error occurring when using the form notification update command without the notification-id arg.
-- Fixed an issue with the entry export command.
+- Updated the ids format of the `wp gf entry list` command to support the page-size and offset args. Credit: Ulrich Pogson.
+- Updated the form export command to support the optional filename arg e.g. `wp gf form export 1 --filename=testing.json`. Credit: Timothy Decker.
+- Fixed an issue where the `wp gf install` command could not network activate plugins.
+- Fixed an error occurring when using the `wp gf form notification update` command without the notification-id arg.
+- Fixed an issue with the `wp gf entry export` command.
 
 = 1.1 =
-- Added support for start_date and end_date filters for the entry export command. e.g. wp gf entry export 11 --start_date="2018-11-01" --end_date="2018-11-11"
-- Added the "wp gf tool system-report" command and the "wp gf tool status" alias for outputting the system report from the Gravity Forms 2.2+ System Status page.
-- Fixed an issue with the "wp gf install" command ending with an error message when no error occurred.
+- Added support for start_date and end_date filters for the entry export command. e.g. `wp gf entry export 11 --start_date="2018-11-01" --end_date="2018-11-11"`
+- Added the `wp gf tool system-report` command and the `wp gf tool status` alias for outputting the system report from the Gravity Forms 2.2+ System Status page.
+- Fixed an issue with the `wp gf install` command ending with an error message when no error occurred.
 - Fixed an issue where old messages could continue to be displayed in the admin following a license key change.
-- Fixed an "invalid synopsis part" warning and an "unknown parameter" error with the wp gf form field update command.
-- Fixed the wp gf form update command using the wrong argument to get the existing form which could result in a form not found error.
-- Fixed an issue with the form create command where missing field IDs are added automatically.
+- Fixed an "invalid synopsis part" warning and an "unknown parameter" error with the `wp gf form field update` command.
+- Fixed the `wp gf form update` command using the wrong argument to get the existing form which could result in a form not found error.
+- Fixed an issue with the `wp gf form create` command where missing field IDs are added automatically.
 
 = 1.0 =
-- Added the wp gf license command.
+- Added the `wp gf license` command.
 - Fixed an issue with updating forms from an export file.
 
 = 1.0-rc-1 =
-- Added the --file arg to the wp gf form update command to allow forms to be updated from an export file.
+- Added the `--file` arg to the `wp gf form update` command to allow forms to be updated from an export file.
 - Fixed a fatal error when using the install command.
 
 = 1.0-beta-5 =
-- Added the wp gf form notification command.
-- Added the wp gf entry notification command.
-- Added the wp version command.
-- Added the wp update command.
-- Updated the install and update commands to download the latest hotfix version by default.
-- Fixed an issue with wp gf form export <form-id> where the form ID is ignored.
+- Added the `wp gf form notification` command.
+- Added the `wp gf entry notification` command.
+- Added the `wp gf version` command.
+- Added the `wp gf update` command.
+- Updated the `install` and `update` commands to download the latest hotfix version by default.
+- Fixed an issue with `wp gf form export <form-id>` where the form ID is ignored.
 
 = 1.0-beta-4 =
-- Updated the install command to pass the --force value to the setup command.
+- Updated the `install` command to pass the `--force` value to the setup command.
 - Updated the output when forcing the setup.
 
 = 1.0-beta-3 =
-- Added the wp gf setup command
-- Fixed an issue with the install command where the database was not setup until visiting the WP dashboard.
+- Added the `wp gf setup` command
+- Fixed an issue with the `install` command where the database was not setup until visiting the WP dashboard.
 - Updated the WP-CLI requirement to 1.0+
 
 = 1.0-beta-2 =