Updated readme.

Author: Danack

.gitignore

@@ -3,3 +3,6 @@ example/output
 example/env.php
 example/example.nginx.conf
 example/example.php-fpm.conf
+autogen
+test/fixtures/output/site.generated.ini
+test/fixtures/output/site.ini

README.md

@@ -1,22 +1,39 @@
 Configurator
 ============
 
-Generates config files from PHP based templates and PHP style config files.
+A few simple tools to manage configuration data sanely. These tools are to hold environment data that can be shared without risk. They are not designed to hold 'secrets' e.g. api/oauth keys.
 
+* Config file generator
 
+* Environment settings
 
-## Generate config files
+* Convert PHP ini files to PHP-FPM format
 
+## Config file generator
 
-Source config file
+This tool allows you to generate config files from PHP based templates and PHP data files that hold all of the setting for the different environments
+
+Source config template file:
 
 ```
+<?php
+
+$config = <<< END
+
+server {
+
     access_log  ${'nginx.log.directory'}/project.access.log requestTime;    
     error_log  ${'nginx.log.directory'}/project.error.log;
     root ${'project.root.directory'}/public;
+}
+
+END;
+
+return $config;
+
 ```
 
-Settings file:
+Data file that holds data for arbitrary environments:
 
 ```
 <?php
@@ -37,8 +54,7 @@ $dave = [
 
 ```
 
-
-configurate data/nginx.conf.php var/generated/nginx.conf centos,dave -p settings.php  
+Running the command `configurate data/nginx.conf.php var/generated/nginx.conf centos,dave -p settings.php` would generated the file:  
 
 
 ```
@@ -48,27 +64,59 @@ configurate data/nginx.conf.php var/generated/nginx.conf centos,dave -p settings
 ```
 
 
+### Syntax
+
+`configurate [-p|--phpsettings="..."] [-j|--jssettings="..."] input output environment`
+
+-p - a comma separated list of PHP data files. Each need to return an array of data.  
+-j - a comma separated list of JSON data files.  
+input - the input template file.  
+output - the output file to write.  
+environment - a comma separated list of environment settings to apply.  
+
 
 
 ## Generate environment settings
 
+A tool that will parse the environment settings required by an application, and the data files that hold the settings for all environments, and will generated a file that contains a function that returns an array of what env settings are required by this application
 
 
-A file that returns an array of what env settings are required by this application
+File listing the environment settings required by the application:
 
 ```
 <?php
 
-use ImagickDemo\Config;
+use ExampleApp\AppConfig;
 
 $env = [
-    Config::CACHING_SETTING,
-    Config::SCRIPT_PACKING,
+    AppConfig::CACHING_SETTING,
+    AppConfig::SCRIPT_PACKING,
+    AppConfig::FILE_STORAGE
 ];
 
 return $env;
 ```
 
+A data file that holds all the data for the various environment settings
+
+```
+$dev = [
+    AppConfig::SCRIPT_PACKING => true,
+    AppConfig::CACHING_SETTING => 'caching.disable',
+];
+
+$live = [
+    AppConfig::SCRIPT_PACKING => true,
+    AppConfig::CACHING_SETTING => 'caching.time'
+]; 
+
+
+// Anyone doing UX testing needs to have the scripts packed together
+// to avoid slow UI responses
+$uxtesting[AppConfig::SCRIPT_PACKING] = true;
+```
+
+Running the command `bin/genenv -p environment/config.php environment/envRequired.php env.php dev,uxtesting`
 
 Produces a file containing a single function that contains all the requested env settings.
 
@@ -78,7 +126,7 @@ Produces a file containing a single function that contains all the requested env
 function getAppEnv() {
     static $env = [
         'caching.setting' => 'caching.revalidate',
-        'script.packing' => '',
+        'script.packing' => 'true',
     ];
 
     return $env;
@@ -89,22 +137,31 @@ function getAppEnv() {
 The keys are the actual strings, rather than the constants used in the application, to allow the settings to be used outside of the application. 
 
 
+### Syntax
 
+`genenv [-p|--phpsettings="..."] [-j|--jssettings="..."] input output environment`
 
+-p - a comma separated list of PHP data files. Each need to return an array of data.  
+-j - a comma separated list of JSON data files.  
+input - the input template file.  
+output - the output file to write.  
+environment - a comma separated list of environment settings to apply.  
 
 ## Convert PHP ini files to PHP-FPM format
 
-Because of reasons, PHP-FPM doesn't use the standard PHP in file format when including ini files in a pool in the PHP-FPM conf file.
+Because of reasons, PHP-FPM doesn't use the standard PHP in file format when including ini files in a pool in the PHP-FPM conf file. This aspect of the Configurator converts PHP style ini files to the format PHP-FPM expects:
 
-This aspect of the Configurator converts PHP style ini files:
+Input ini file:
 
 ```
 extension=imagick.so
 default_charset = "utf-8";
 post_max_size = 10M
 ```
 
-to PHP-FPM style files:
+Running the command `php bin/fpmconv example.php.ini example.phpfpm.ini`
+
+will generate this PHP-FPM ini file
 
 ```
 php_admin_value[extension] = "imagick.so"