update docs for recent pull requst, cleanup

betojsx · Oct 7, 2016 · 1951ffd · 1951ffd
1 parent 94b867f
commit 1951ffd
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,9 +1,13 @@
 
 # CHANGELOG
 
-## Head (1.7.2) | 02.08.2016
+## Head (1.7.3) | 07.10.2016
+* add option to define WordPress Version
+* documentation updates
 * add rewrite flush to make sure permalinks are working correctly
 
+Contributors: @flurinduerst, @ShaneShipston
+
 ## 1.7.1 | 02.08.2016
 * fixed a bug that caused an error if a theme was installed that doesn't end with `master.zip`
 * add additional options

diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 
 ![Screenshot](http://files.flurinduerst.ch/wpdistillery/wpdistillery_logo.png)
 
-**Version:** 1.7.2
+**Version:** 1.7.3
 
 **Update Note:** Version 1.7 brings lots of new settings. Check out the [configuration file documentation](README_CONFIG.md).
 
@@ -31,9 +31,9 @@ WP Distillery is designed for [Scotch Box](https://box.scotch.io/). Since `WPDis
 ## Setup
 To setup a new project running Scotch Box and WordPress simply follow these steps:
 
-1. Run the following command inside your project root to install both Scotch Box & WPDistillery: 
+1. Run the following command inside your project root to install both Scotch Box & WPDistillery:
 
-  `git clone https://github.com/scotch-io/scotch-box.git && mv scotch-box/public public && mv scotch-box/Vagrantfile Vagrantfile && rm -rf scotch-box && git clone --depth 1 https://github.com/flurinduerst/WPDistillery.git && mv WPDistillery/config.yml config.yml && mv WPDistillery/setup.sh setup.sh && rm -rf WPDistillery` 
+  `git clone https://github.com/scotch-io/scotch-box.git && mv scotch-box/public public && mv scotch-box/Vagrantfile Vagrantfile && rm -rf scotch-box && git clone --depth 1 https://github.com/flurinduerst/WPDistillery.git && mv WPDistillery/config.yml config.yml && mv WPDistillery/setup.sh setup.sh && rm -rf WPDistillery`
 2. add environment variables and your preferred options into `config.yml` (see [configuration file documentation](README_CONFIG.md) for additional info on `config.yml`)
 3. `vagrant up` then `vagrant ssh`
 4. update wp cli `sudo wp cli update --allow-root` see [Known Issues](https://github.com/flurinduerst/WPDistillery#known-issues)
@@ -45,7 +45,7 @@ If you're using Windows, replace step #5 with the following:
 sudo apt-get install -y dos2unix
 cd ../../var/www
 dos2unix config.yml
-dos2unix setup.sh 
+dos2unix setup.sh
 bash setup.sh
 ```
 Thanks to [@rowboat85](https://github.com/rowboat85) and [@ShaneShipston](https://github.com/ShaneShipston) for pointing this out.

diff --git a/README_CONFIG.md b/README_CONFIG.md
@@ -13,6 +13,7 @@ The configuration file is split into five sections:
 
 ## Installation
 * In **`wpfolder`** you define the folder containing WordPress. Within the current version of Scotch Box this is `public` by default.
+* In **`wpversion`** you can define what WordPress version to install.
 * With **`wplocale`** you can select what language to download and install WordPress. Use language Codes like `en_US` or `en_GB`.
 * Add your timezone as string to **`timezone`**. See [List of Supported Timezones](http://php.net/manual/en/timezones.php).
 * **`admin`** defines the default admin user. Set your preferred username, password and email.
@@ -25,6 +26,9 @@ The configuration file is split into five sections:
 # WordPress folder
 wpfolder: public
 
+# WordPress version
+wpversion: latest
+
 # language/timezone
 wplocale: en_US
 timezone: America/New_York

diff --git a/config.yml b/config.yml
@@ -6,7 +6,7 @@
 # For detailed instructions on this file read the config.yml-documentation at
 # https://github.com/flurinduerst/WPDistillery/blob/master/README_CONFIG.md
 #
-# File Version: 1.5.1
+# File Version: 1.6.0
 
 
 # INSTALLATION
@@ -15,7 +15,7 @@
 # WordPress folder
 wpfolder: public
 
-# WordPress Version
+# WordPress version
 wpversion: latest
 
 # language/timezone