updated readme, fixed #3

Author: nickbreen

README.md

@@ -12,30 +12,34 @@ See `docker-compose.yml` for a usage example.
 
 `attach` or `exec` (etc) into the container and execute `setup`.
 
+    docker exec -itu wp CONTAINER bash -l -c 'setup'
+
 This image provides and uses [WP-CLI].
 
-# Configuration
+## Download
+
+The version and a locale can be specified with environment variables.
 
-The database configuration can be specified explicitly with:
+| Variable   | Example | Default
+|------------|---------|---------
+| WP_VERSION | 4.4.2   | Latest
+| WP_LOCALE  | en_NZ   | en_US
 
-- `WP_DB_HOST`
-- `WP_DB_PORT`
-- `WP_DB_NAME`
-- `WP_DB_USER`
-- `WP_DB_PASSWORD`
-- `WP_DB_PREFIX`
+## Configuration
+
+The database configuration can be specified explicitly with environment variables.
 
 If any are omitted then values are inferred from the linked ```:mysql```
 container, otherwise sensible defaults are used.
 
-Variable             | Value inferred from            | Default
--------------------- | ------------------------------ | ---------
-`WP_DB_NAME`         | `MYSQL_ENV_MYSQL_DATABASE`     | wordpress
-`WP_DB_USER`         | `MYSQL_ENV_MYSQL_USER`         | wordpress
-`WP_DB_PASSWORD`     | `MYSQL_ENV_MYSQL_PASSWORD`     | wordpress
-`WP_DB_HOST`         | `MYSQL_PORT_3306_TCP_ADDR`     | mysql
-`WP_DB_PORT`         | `MYSQL_PORT_3306_TCP_PORT`     | 3306
-`WP_DB_PREFIX`       | N/A                            | wp_
+| Variable       | Value inferred from      | Default
+|----------------| -------------------------| ---------
+| WP_DB_NAME     | MYSQL_ENV_MYSQL_DATABASE | wordpress
+| WP_DB_USER     | MYSQL_ENV_MYSQL_USER     | wordpress
+| WP_DB_PASSWORD | MYSQL_ENV_MYSQL_PASSWORD | wordpress
+| WP_DB_HOST     | MYSQL_PORT_3306_TCP_ADDR | mysql
+| WP_DB_PORT     | MYSQL_PORT_3306_TCP_PORT | 3306
+| WP_DB_PREFIX   | N/A                      | wp_
 
 `--extra-php` is supported with the `WP_EXTRA_PHP` environment variable. E.g.
 
@@ -47,33 +51,32 @@ Variable             | Value inferred from            | Default
 The initial DB is installed, if not already installed in the DB, using the
 following variables; the setup script will complain if any are unset.
 
-- `WP_LOCALE` (default `en_NZ`)
-- `WP_URL`
-- `WP_TITLE`
-- `WP_ADMIN_USER`
-- `WP_ADMIN_PASSWORD`
-- `WP_ADMIN_EMAIL`
+| Variable          | Example             | Default
+|-------------------|---------------------|---------
+| WP_LOCALE         | en_NZ               | en_US
+| WP_URL            | http://example.com  |
+| WP_TITLE          | Example Title       |
+| WP_ADMIN_EMAIL    | admin@example.com   |
+| WP_ADMIN_USER     | admin               |
+| WP_ADMIN_PASSWORD |                     |
 
-## Arbitrary WP-CLI Commands
+## Multisite
 
-Any arbitrary WP-CLI commands can be executed, actually any commands as the
-value is processed by `sh`. Any environment variable prefixed with `WP_COMMANDS`
-will be processed.
+Multisite is supported, it is enabled when the `WP_SUBDOMAINS` environment
+variable is set.
+
+| Variable      | Example
+|---------------|---------
+| WP_SUBDOMAINS | "yes"  
 
-    WP_COMMANDS_0: |
-      wp plugin activate --network jetpack
-    WP_COMMANDS_1: |
-      wp site create --slug=site1 --title="Site 1"
-      wp --url=http://site1.example.com rewrite structure /%postname%
-      wp --url=http://site1.example.com rewrite flush
-    WP_COMMANDS_2: |
-      wp site create --slug=site2 --title="Site 2"
-      wp --url=http://site2.example.com rewrite structure /%postname%
-      wp --url=http://site2.example.com rewrite flush
-    WP_COMMANDS_3: |
-      wp site create --slug=site3 --title="Site 3"
-      wp --url=http://site3.example.com rewrite structure /%postname%
-      wp --url=http://site3.example.com rewrite flush
+Path-based multisites are not supported.
+
+A domain mapping plugin is not required. Use the convenience function to  
+register a new site.
+
+    WP_COMMANDS: |
+      new_site sitea sitea.dev http://sitea.dev "Site A"
+      wp --url=http://sitea.dev theme activate twentyfourteen
 
 ## Themes and Plugins
 
@@ -90,11 +93,11 @@ Themes and plugins can also be installed from [Bitbucket] (OAuth 1.0a supported
 for private repositories) and [GitHub] (HTTP Basic Auth using personal access
 tokens for private repositories); e.g.:
 
-  WP_COMMANDS: |
-    wp github theme install CherryFramework/CherryFramework v3.1.5
-    wp github theme install CherryFramework/CherryFramework v3.1.5 --token=XXXXX
-    wp bitbucket plugin install CherryFramework/cherry-plugin v3.1.5
-    wp bitbucket plugin install CherryFramework/cherry-plugin v3.1.5 --key=XXXX --secret=XXXXXX
+    WP_COMMANDS: |
+      wp github theme install CherryFramework/CherryFramework v3.1.5
+      wp github theme install CherryFramework/CherryFramework v3.1.5 --token=XXX
+      wp bitbucket plugin install CherryFramework/cherry-plugin v3.1.5
+      wp bitbucket plugin install CherryFramework/cherry-plugin v3.1.5 --key=XXX --secret=XXX
 
 For both GitHub and Bitbucket the version/release tag is optional and defaults
 to the `latest` release, or if no releases exist, to `master`.
@@ -103,3 +106,17 @@ to the `latest` release, or if no releases exist, to `master`.
 [Bitbucket]: https://bitbucket.com
 [GitHub]: https://github.com
 [WordPress]: https://wordpress.org
+
+## Arbitrary Commands
+
+Any arbitrary commands can be executed, actually any commands as the
+value is processed by `sh`. Any environment variable prefixed with `WP_COMMANDS`
+will be processed.
+
+    WP_COMMANDS_0: | # Install plugins
+      wp plugin install jetpack --activate
+    WP_COMMANDS_1: | # Configure themes
+      wp theme activate twentyfourteen
+    WP_COMMANDS_2: | # Set some options
+      wp rewrite structure /%postname%
+      wp rewrite flush