From d268beccae9aa2b79f52f2dab4d2c7005d9f2dee Mon Sep 17 00:00:00 2001
From: Tim Hockin <thockin@google.com>
Date: Wed, 8 Nov 2017 09:36:26 -0800
Subject: [PATCH] Update README for micro-demos

Also remove kubectl script, which should not have been committed.
---
 micro-demos/README.md | 36 ++++++++++++++++++++++++++++++------
 micro-demos/kubectl   |  3 ---
 2 files changed, 30 insertions(+), 9 deletions(-)
 delete mode 100755 micro-demos/kubectl

diff --git a/micro-demos/README.md b/micro-demos/README.md
index 2fdb2754e5..3f81ec6ca9 100644
--- a/micro-demos/README.md
+++ b/micro-demos/README.md
@@ -1,10 +1,34 @@
-# kube-demos
-Kubernetes demos
+# Kubernetes micro-demos
 
-To run these demos you need 'pv' and 'tmux' installed.
+This is a collection of highly-targetted demonstrations of Kubernetes features.
+The demos are all text-based and automated, making them perfect for customer
+meetings, meetups, or just showing off to your colleagues.
 
-To make best use of these demos:
+## Running the demos
 
-SSH to your kubernetes-master and set the following flags (in this order):
-  * kube-controllermanager: --pod-eviction-timeout=10s
+To run these demos you need `pv` and `tmux` installed, and you need `kubectl`
+in your PATH.
+
+Some of the demos try to act in faster-than-real time.  For best results:
+  * SSH to your kubernetes-master and set the following flags (in this order):
+    * kube-controllermanager: --pod-eviction-timeout=10s
+
+Before running a demo, make sure your cluster is demo-ready.  The `reset.sh`
+script is provided for that.
+
+## Writing new demos
+
+Each demo lives in its own directory.  The bulk of the logic lives in
+`util.sh`.
+
+Demos should be small and focused - 2 to 3 minutes each.
+
+Demos should be repeatable.  Make sure you are not relying on timing effects.
+If you need to `sleep`, you might have a problem.
+
+Demos should be self-contained.  If you are depending on something being done
+before-hand, don't.  Do it in the demo script.
+
+Demos should be single-terminal.  Use `tmux` to split the window to show
+multiple parallel things.
 
diff --git a/micro-demos/kubectl b/micro-demos/kubectl
deleted file mode 100755
index f7713c17fa..0000000000
--- a/micro-demos/kubectl
+++ /dev/null
@@ -1,3 +0,0 @@
-#!/bin/sh
-
-~/src/kubernetes/cluster/kubectl.sh "$@"