Merge pull request #413 from monopole/demoReadme

README for demos

cmd/kinflate/README.md

@@ -1,8 +1,9 @@
 # kinflate
 
-[_kubectl apply_]: docs/glossary.md#apply
+[applied]: docs/glossary.md#apply
 [base]: docs/glossary.md#base
 [declarative configuration]: docs/glossary.md#declarative-application-management
+[demo]: demos/README.md
 [imageBase]: docs/base.jpg
 [imageOverlay]: docs/overlay.jpg
 [manifest]: docs/glossary.md#manifest
@@ -14,6 +15,16 @@
 template-free customization of declarative
 configuration targetted to kubernetes.
 
+## Installation
+
+Assumes [Go](https://golang.org/) is installed
+and your `PATH` contains `$GOPATH/bin`:
+
+<!-- @installKinflate @test -->
+```
+go get k8s.io/kubectl/cmd/kinflate
+```
+
 ## Usage
 
 #### 1) Make a base
@@ -28,27 +39,14 @@ secrets that serve some common purpose.
 
 An [overlay] customizes your base along different dimensions
 for different purposes or different teams, e.g. for
-_development, staging, production_.
+_development, staging and production_.
 
 ![overlay image][imageOverlay]
 
 #### 3) Run kinflate
 
-Run kinflate on your overlay.  The result, a set of
+Run kinflate on your overlay.  The result
-complete resources, is printed to stdout, suitable for
+is printed to `stdout` as a set of complete
-sending to your cluster.
+resources, ready to be [applied] to a cluster.
 
-## Installation
+For more details, try a [demo].
-
-Assumes [Go](https://golang.org/) is installed
-and your `PATH` contains `$GOPATH/bin`:
-
-<!-- @installKinflate @test -->
-```
-go get k8s.io/kubectl/cmd/kinflate
-```
-
-## Demos
-
- * [hello world](demo/helloWorld.md)
- * [mysql](demo/mySql.md)

cmd/kinflate/demos/README.md

@@ -0,0 +1,10 @@
+# Demos
+
+These demos are covered by presubmit tests.
+
+ * [hello world](helloWorld.md) - Deploy multiple
+   (differently configured) instances of a simple Hello
+   World server.
+
+ * [mysql](mySql.md) - Create a mySql production
+   configuration from scratch.