Added readmes for examples

4 files changed, 45 insertions, 0 deletions

diff --git a/examples/README b/examples/README
new file mode 100644
index 0000000..e0def3c
--- /dev/null
+++ b/examples/README
@@ -0,0 +1,12 @@
+Click Examples
+
+  This folder contains various click examples.  Note that
+  all of these are not runnable by themselves but should be
+  installed into a virtualenv.
+
+  This is done this way so that scripts also properly work
+  on Windows and in virtualenvs without accidentally executing
+  through the wrong interpreter.
+
+  For more information about this see the documentation:
+    http://click.pocoo.org/setuptools/
diff --git a/examples/inout/README b/examples/inout/README
new file mode 100644
index 0000000..6309bc8
--- /dev/null
+++ b/examples/inout/README
@@ -0,0 +1,10 @@
+$ inout_
+
+  inout is a simple example of an application that
+  can read from files and write to files but also
+  accept input from stdin or write to stdout.
+
+Usage:
+
+  $ pip install --editable .
+  $ inout input_file.txt output_file.txt
diff --git a/examples/naval/README b/examples/naval/README
new file mode 100644
index 0000000..aa289a2
--- /dev/null
+++ b/examples/naval/README
@@ -0,0 +1,14 @@
+$ naval_
+
+  naval is a simple example of an application that
+  is ported from the docopt example of the same name.
+
+  Unlike the original this one also runs some code and
+  prints messages and it's command line interface was
+  changed slightly to make more sense with established
+  POSIX semantics.
+
+Usage:
+
+  $ pip install --editable .
+  $ naval --help
diff --git a/examples/repo/README b/examples/repo/README
new file mode 100644
index 0000000..52d1fa7
--- /dev/null
+++ b/examples/repo/README
@@ -0,0 +1,9 @@
+$ repo_
+
+  repo is a simple example of an application that looks
+  and works similar to hg or git.
+
+Usage:
+
+  $ pip install --editable .
+  $ repo --help