README.md in kitchen-docker-0.1.1.dev vs README.md in kitchen-docker-0.1.1
- old
+ new
@@ -2,22 +2,35 @@
A Test Kitchen Driver for Docker.
## <a name="requirements"></a> Requirements
-**TODO:** document any software or library prerequisites that are required to
-use this driver. Implement the `#verify_dependencies` method in your Driver
-class to enforce these requirements in code, if possible.
+* [Docker][docker_getting_started]
## <a name="installation"></a> Installation and Setup
Please read the [Driver usage][driver_usage] page for more details.
## <a name="config"></a> Configuration
-**TODO:** Write descriptions of all configuration options
+### <a name="config-image"></a> image
+The Docker image to use as the base for the suite containers. You can find
+images using the [Docker Index][docker_index].
+
+The default value is `ubuntu` ([image][docker_default_image]).
+
+### <a name="config-platform"></a> platform
+
+The platform of the chosen image. This is used to properly bootstrap the
+suite container for Test Kitchen. Kitchen Docker currently supports:
+
+* `debian` or `ubuntu`
+* `rhel` or `centos`
+
+The default value is `ubuntu`.
+
### <a name="config-require-chef-omnibus"></a> require\_chef\_omnibus
Determines whether or not a Chef [Omnibus package][chef_omnibus_dl] will be
installed. There are several different behaviors available:
@@ -28,11 +41,11 @@
* `<VERSION_STRING>` (ex: `10.24.0`) - the desired version string will
be passed the the install.sh script. Subsequent converges will skip if
the installed version and the desired version match.
* `false` or `nil` - no chef is installed.
-The default value is unset, or `nil`.
+The default value is `true`.
## <a name="development"></a> Development
* Source hosted at [GitHub][repo]
* Report issues/questions/feature requests on [GitHub Issues][issues]
@@ -54,11 +67,14 @@
## <a name="license"></a> License
Apache 2.0 (see [LICENSE][license])
-[author]: https://github.com/enter-github-user
-[issues]: https://github.com/enter-github-user/kitchen-docker/issues
-[license]: https://github.com/enter-github-user/kitchen-docker/blob/master/LICENSE
-[repo]: https://github.com/enter-github-user/kitchen-docker
-[driver_usage]: http://docs.kitchen-ci.org/drivers/usage
-[chef_omnibus_dl]: http://www.opscode.com/chef/install/
+[author]: https://github.com/portertech
+[issues]: https://github.com/portertech/kitchen-docker/issues
+[license]: https://github.com/portertech/kitchen-docker/blob/master/LICENSE
+[repo]: https://github.com/portertech/kitchen-docker
+[docker_getting_started]: http://www.docker.io/gettingstarted/
+[docker_index]: https://index.docker.io/
+[docker_default_image]: https://index.docker.io/_/ubuntu/
+[driver_usage]: http://docs.kitchen-ci.org/drivers/usage
+[chef_omnibus_dl]: http://www.opscode.com/chef/install/