Clean up the readme a bit

Author: sebastiaandegeus

.gitignore

@@ -1,3 +1,4 @@
 /vendor/
 /features/bootstrap/test_exports/
 /wordpress/
+readme.txt

README.md

@@ -7,15 +7,6 @@ WP-CLI for Advanced Custom Fields helps you manage your field-groups through WP-
 The reason we started this project is to make life easier for developers working on Wordpress projects using the Advanced Custom Fields Pro plugin.
 Fields can now easily be imported, exported and shared over SVN, GIT or comparable systems.
 
-
-### Reasons to start this project 
-
-* Advanced custom fields did not interface with WP-CLI
-* Sharing field-groups through XML or PHP code caused problems with differences between development, test, staging and production enviroments when shared with XML.
-* No direct SVN or GIT support without manually putting the exported PHP or XML into a versioned directory.
-* Naming convention for XML files was always the same, resulting in renaming hassle.
-* Only using the generated field-groups on runtime through PHP code in functions.php disables the editing mode (which is an awesome UI that we require). So importing should be possible.
-
 ## Installation 
 
 
@@ -27,18 +18,27 @@ Fields can now easily be imported, exported and shared over SVN, GIT or comparab
 
 ### How to install 
 
-Install WP-CLI as described on [their website](http://wp-cli.org/ "WP-CLI")
+Install WP-CLI as described on [http://wp-cli.org/](http://wp-cli.org/ "WP-CLI")
+
+Using composer:
+```
+composer require wpackagist-plugin/advanced-custom-fields-wpcli
+```
 
-Clone this repo to your plugins directory
+By GIT clone in plugins directory:
 ```
 git clone https://github.com/hoppinger/advanced-custom-fields-wpcli.git
 ```
+
+WordPress plugin installation:
+Download zip and put the files in the plugins directory.
+
 * Activate this plugin in the plugin menu or using:
 ```
 wp plugin activate advanced-custom-fields-wpcli
 ```
 
-Go the wordpress directory in your terminal and try out to:
+Go the wordpress directory in your terminal and run:
 ```
 wp acf
 ```
@@ -64,9 +64,13 @@ Prints the help overview and can be used as a default test to see if the plugin
 
 
 ### Export 
+
+Export a field-group to a json file in the directory set by a filter.
+```
 wp acf export
 ```
-Export a field-group to a json file in the directory set by a filter. You want to export all field-groups all at once you can use:
+
+You want to export all field-groups all at once you can use:
 ```
 wp acf export --all
 ```
@@ -95,8 +99,6 @@ Do this after you have edited fields-groups from the UI and exported the changes
 The acfwpcli_fieldgroup_paths gives you the ability to add more paths where ACF-CLI should load/export from/to.
 You should always add at least one path to this filter.
 
-**Example:**
-
 ```
 add_filter( 'acfwpcli_fieldgroup_paths', 'add_plugin_path' );
 

readme.txt

@@ -14,14 +14,6 @@ Manage Advanced Custom Fields through WP-CLI
 WP-CLI for Advanced Custom Fields helps you manage your field-groups through WP-CLI.
 The reason we started this project is to make life easier for developers working on Wordpress projects using the Advanced Custom Fields Pro plugin.
 Fields can now easily be imported, exported and shared over SVN, GIT or comparable systems.
-
-= Reasons to start this project =
-
-* Advanced custom fields did not interface with WP-CLI
-* Sharing field-groups through XML or PHP code caused problems with differences between development, test, staging and production enviroments when shared with XML.
-* No direct SVN or GIT support without manually putting the exported PHP or XML into a versioned directory.
-* Naming convention for XML files was always the same, resulting in renaming hassle.
-* Only using the generated field-groups on runtime through PHP code in functions.php disables the editing mode (which is an awesome UI that we require). So importing should be possible.
 == Installation ==
 
 = Requirements =
@@ -31,18 +23,27 @@ Fields can now easily be imported, exported and shared over SVN, GIT or comparab
 
 = How to install =
 
-Install WP-CLI as described on [their website](http://wp-cli.org/ "WP-CLI")
+Install WP-CLI as described on [http://wp-cli.org/](http://wp-cli.org/ "WP-CLI")
+
+Using composer:
+```
+composer require wpackagist-plugin/advanced-custom-fields-wpcli
+```
 
-Clone this repo to your plugins directory
+By GIT clone in plugins directory:
 ```
 git clone https://github.com/hoppinger/advanced-custom-fields-wpcli.git
 ```
+
+WordPress plugin installation:
+Download zip and put the files in the plugins directory.
+
 * Activate this plugin in the plugin menu or using:
 ```
 wp plugin activate advanced-custom-fields-wpcli
 ```
 
-Go the wordpress directory in your terminal and try out to:
+Go the wordpress directory in your terminal and run:
 ```
 wp acf
 ```
@@ -60,8 +61,6 @@ remove_action('plugins_loaded', 'acf_wpcli_register_groups');
 The acfwpcli_fieldgroup_paths gives you the ability to add more paths where ACF-CLI should load/export from/to.
 You should always add at least one path to this filter.
 
-**Example:**
-
 ```
 add_filter( 'acfwpcli_fieldgroup_paths', 'add_plugin_path' );
 
@@ -82,9 +81,13 @@ Prints the help overview and can be used as a default test to see if the plugin
 ```
 
 = Export =
+
+Export a field-group to a json file in the directory set by a filter.
+```
 wp acf export
 ```
-Export a field-group to a json file in the directory set by a filter. You want to export all field-groups all at once you can use:
+
+You want to export all field-groups all at once you can use:
 ```
 wp acf export --all
 ```

readme/command.txt

@@ -10,9 +10,13 @@ Prints the help overview and can be used as a default test to see if the plugin
 ```
 
 = Export =
+
+Export a field-group to a json file in the directory set by a filter.
+```
 wp acf export
 ```
-Export a field-group to a json file in the directory set by a filter. You want to export all field-groups all at once you can use:
+
+You want to export all field-groups all at once you can use:
 ```
 wp acf export --all
 ```

readme/description.txt

@@ -5,11 +5,3 @@
 WP-CLI for Advanced Custom Fields helps you manage your field-groups through WP-CLI.
 The reason we started this project is to make life easier for developers working on Wordpress projects using the Advanced Custom Fields Pro plugin.
 Fields can now easily be imported, exported and shared over SVN, GIT or comparable systems.
-
-= Reasons to start this project =
-
-* Advanced custom fields did not interface with WP-CLI
-* Sharing field-groups through XML or PHP code caused problems with differences between development, test, staging and production enviroments when shared with XML.
-* No direct SVN or GIT support without manually putting the exported PHP or XML into a versioned directory.
-* Naming convention for XML files was always the same, resulting in renaming hassle.
-* Only using the generated field-groups on runtime through PHP code in functions.php disables the editing mode (which is an awesome UI that we require). So importing should be possible.

readme/filters.txt

@@ -5,8 +5,6 @@
 The acfwpcli_fieldgroup_paths gives you the ability to add more paths where ACF-CLI should load/export from/to.
 You should always add at least one path to this filter.
 
-**Example:**
-
 ```
 add_filter( 'acfwpcli_fieldgroup_paths', 'add_plugin_path' );
 

readme/installation.txt

@@ -7,18 +7,27 @@
 
 = How to install =
 
-Install WP-CLI as described on [their website](http://wp-cli.org/ "WP-CLI")
+Install WP-CLI as described on [http://wp-cli.org/](http://wp-cli.org/ "WP-CLI")
 
-Clone this repo to your plugins directory
+Using composer:
+```
+composer require wpackagist-plugin/advanced-custom-fields-wpcli
+```
+
+By GIT clone in plugins directory:
 ```
 git clone https://github.com/hoppinger/advanced-custom-fields-wpcli.git
 ```
+
+WordPress plugin installation:
+Download zip and put the files in the plugins directory.
+
 * Activate this plugin in the plugin menu or using:
 ```
 wp plugin activate advanced-custom-fields-wpcli
 ```
 
-Go the wordpress directory in your terminal and try out to:
+Go the wordpress directory in your terminal and run:
 ```
 wp acf
 ```