diff --git a/.gitattributes b/.gitattributes index f6faf5d..84f0a11 100644 --- a/.gitattributes +++ b/.gitattributes @@ -6,4 +6,5 @@ /.gitattributes export-ignore /.gitignore export-ignore /change_log.txt export-ignore -/readme.md export-ignore \ No newline at end of file +/README.md export-ignore +/composer.lock export-ignore \ No newline at end of file diff --git a/README.md b/README.md index 3bf10b2..c0b5051 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,22 @@ The Gravity Forms CLI Add-On allows WP-CLI users to manage installation, forms a [Documentation](https://docs.gravityforms.com/category/add-ons-gravity-forms/wp-cli-add-on/) +Installation +------------ + +**As a WP-CLI package (recommended):** + + wp package install gravityforms/gravityformscli + +**As a WordPress plugin:** + + wp plugin install gravityformscli --activate + +**Or install from GitHub:** + + wp package install https://github.com/gravityforms/gravityformscli.git + + Getting started --------------- diff --git a/composer.json b/composer.json index 1a17084..2004410 100644 --- a/composer.json +++ b/composer.json @@ -2,11 +2,17 @@ "name": "gravityforms/gravityformscli", "description": "A set of WP-CLI commands to manage Gravity Forms.", "type": "wp-cli-package", + "keywords": [ + "wp-cli", + "gravity-forms", + "cli", + "wordpress" + ], "homepage": "https://github.com/gravityforms/gravityformscli", "support": { "issues": "https://gravityforms.com" }, - "license": "GPLv3", + "license": "GPL-3.0-or-later", "authors": [ { "name": "Rocketgenius", @@ -15,9 +21,22 @@ } ], "require": { - "php": ">=5.3.29" + "php": ">=5.6", + "wp-cli/wp-cli": "^2.5" }, "autoload": { - "files": [ "cli.php" ] + "files": [ + "cli.php" + ] + }, + "extra": { + "commands": [ + "gf", + "gf form", + "gf field", + "gf entry", + "gf license", + "gf tool" + ] } -} +} \ No newline at end of file