From 2f29fab931defe3d6cf022ab43a370ec4f8ea519 Mon Sep 17 00:00:00 2001
From: Stian Thorgersen <stianst@gmail.com>
Date: Wed, 12 Mar 2014 16:09:22 +0000
Subject: [PATCH] Added a README.md in the root of examples to describe the
 difference between preconfigured-demo and unconfigured-demo

---
 distribution/examples-docs-zip/build.xml  |  5 ++++-
 examples/demo-template/README.md.overview | 10 ++++++++++
 2 files changed, 14 insertions(+), 1 deletion(-)
 create mode 100755 examples/demo-template/README.md.overview

diff --git a/distribution/examples-docs-zip/build.xml b/distribution/examples-docs-zip/build.xml
index f73aca50df..9713e6cc84 100755
--- a/distribution/examples-docs-zip/build.xml
+++ b/distribution/examples-docs-zip/build.xml
@@ -8,6 +8,7 @@
                 <exclude name="**/*.iml"/>
                 <exclude name="**/*.unconfigured"/>
                 <exclude name="**/subsystem-config.xml"/>
+                <exclude name="**/README.md.overview"/>
             </fileset>
         </copy>
         <copy todir="target/examples/unconfigured-demo" overwrite="true">
@@ -19,11 +20,13 @@
                 <exclude name="**/target/**"/>
                 <exclude name="**/*.iml"/>
                 <exclude name="**/README.md"/>
+                <exclude name="**/README.md.overview"/>
             </fileset>
         </copy>
+        <copy file="../../examples/demo-template/README.md.overview" tofile="target/examples/README.md"/>
         <move file="target/examples/unconfigured-demo/README.md.unconfigured" tofile="target/examples/unconfigured-demo/README.md"/>
         <move file="target/examples/unconfigured-demo/customer-app/src/main/webapp/WEB-INF/web.xml.unconfigured" tofile="target/examples/unconfigured-demo/customer-app/src/main/webapp/WEB-INF/web.xml"/>
         <move file="target/examples/unconfigured-demo/product-app/src/main/webapp/WEB-INF/web.xml.unconfigured" tofile="target/examples/unconfigured-demo/product-app/src/main/webapp/WEB-INF/web.xml"/>
         <move file="target/examples/unconfigured-demo/database-service/src/main/webapp/WEB-INF/web.xml.unconfigured" tofile="target/examples/unconfigured-demo/database-service/src/main/webapp/WEB-INF/web.xml"/>
     </target>
-</project>
\ No newline at end of file
+</project>
diff --git a/examples/demo-template/README.md.overview b/examples/demo-template/README.md.overview
new file mode 100755
index 0000000000..f09f2cf66e
--- /dev/null
+++ b/examples/demo-template/README.md.overview
@@ -0,0 +1,10 @@
+Login, Distributed SSO, Distributed Logout, and OAuth Token Grant Examples
+===================================
+
+Preconfigured Examples
+===================================
+The Preconfigured Examples (in 'preconfigured-demo') contains pre-configured examples that can be deployed without having to configure anything except importing the realm settings into Keycloak. To try this out follow the instructions in preconfigured-demo/README.md.
+
+Unconfigured Examples
+===================================
+The Unconfigured Examples (in 'unconfigured-demo') contains examples without any Keycloak specific configuration. These should be used in conjunction with the online screencasts tutorials at [http://keycloak.org/docs](http://keycloak.org/docs).