From daca0fd8e2804fc7b3997c1353f3213fdfa375b6 Mon Sep 17 00:00:00 2001
From: Marcelo Gornstein <marcelog@gmail.com>
Date: Sun, 3 Jan 2016 16:58:45 -0300
Subject: [PATCH] updating doc

---
 README.md                                               | 9 +++++++--
 {docs => doc}/examples/mock/MyPAGIApplication.php       | 0
 {docs => doc}/examples/mock/mocktest.php                | 0
 {docs => doc}/examples/node/example.php                 | 0
 {docs => doc}/examples/node/run.php                     | 0
 {docs => doc}/examples/node/test_example.php            | 0
 {docs => doc}/examples/nodecontroller/example.php       | 0
 {docs => doc}/examples/nodecontroller/run.php           | 0
 {docs => doc}/examples/quickstart/MyPAGIApplication.php | 0
 {docs => doc}/examples/quickstart/run.sh                | 0
 {docs => doc}/examples/quickstart/spooling.php          | 0
 11 files changed, 7 insertions(+), 2 deletions(-)
 rename {docs => doc}/examples/mock/MyPAGIApplication.php (100%)
 rename {docs => doc}/examples/mock/mocktest.php (100%)
 rename {docs => doc}/examples/node/example.php (100%)
 rename {docs => doc}/examples/node/run.php (100%)
 rename {docs => doc}/examples/node/test_example.php (100%)
 rename {docs => doc}/examples/nodecontroller/example.php (100%)
 rename {docs => doc}/examples/nodecontroller/run.php (100%)
 rename {docs => doc}/examples/quickstart/MyPAGIApplication.php (100%)
 rename {docs => doc}/examples/quickstart/run.sh (100%)
 rename {docs => doc}/examples/quickstart/spooling.php (100%)

diff --git a/README.md b/README.md
index 7647c19..1c2be0f 100644
--- a/README.md
+++ b/README.md
@@ -7,8 +7,8 @@
 [![Code Climate](https://codeclimate.com/github/marcelog/PAGI/badges/gpa.svg)](https://codeclimate.com/github/marcelog/PAGI)
 [![Issue Count](https://codeclimate.com/github/marcelog/PAGI/badges/issue_count.svg)](https://codeclimate.com/github/marcelog/PAGI)
 
-Introduction
-============
+# Introduction
+
 This framework is intended to simply making ivr applications using Asterisk's
 AGI, providing a nice level of abstraction over what an IVR should look like
 from a developers' perspective.
@@ -31,6 +31,11 @@ composer.json:
   }
 ```
 
+# Documentation
+
+  * Autogenerated documentation for this source can be found in the [doc](https://github.com/marcelog/PAGI/blob/master/doc/ApiIndex.md) directory.
+  * Some usage examples can be found in the [doc/examples](https://github.com/marcelog/PAGI/blob/master/doc/examples) directory.
+
 # Included Examples
 Please see **docs/examples** for all the included examples.
 
diff --git a/docs/examples/mock/MyPAGIApplication.php b/doc/examples/mock/MyPAGIApplication.php
similarity index 100%
rename from docs/examples/mock/MyPAGIApplication.php
rename to doc/examples/mock/MyPAGIApplication.php
diff --git a/docs/examples/mock/mocktest.php b/doc/examples/mock/mocktest.php
similarity index 100%
rename from docs/examples/mock/mocktest.php
rename to doc/examples/mock/mocktest.php
diff --git a/docs/examples/node/example.php b/doc/examples/node/example.php
similarity index 100%
rename from docs/examples/node/example.php
rename to doc/examples/node/example.php
diff --git a/docs/examples/node/run.php b/doc/examples/node/run.php
similarity index 100%
rename from docs/examples/node/run.php
rename to doc/examples/node/run.php
diff --git a/docs/examples/node/test_example.php b/doc/examples/node/test_example.php
similarity index 100%
rename from docs/examples/node/test_example.php
rename to doc/examples/node/test_example.php
diff --git a/docs/examples/nodecontroller/example.php b/doc/examples/nodecontroller/example.php
similarity index 100%
rename from docs/examples/nodecontroller/example.php
rename to doc/examples/nodecontroller/example.php
diff --git a/docs/examples/nodecontroller/run.php b/doc/examples/nodecontroller/run.php
similarity index 100%
rename from docs/examples/nodecontroller/run.php
rename to doc/examples/nodecontroller/run.php
diff --git a/docs/examples/quickstart/MyPAGIApplication.php b/doc/examples/quickstart/MyPAGIApplication.php
similarity index 100%
rename from docs/examples/quickstart/MyPAGIApplication.php
rename to doc/examples/quickstart/MyPAGIApplication.php
diff --git a/docs/examples/quickstart/run.sh b/doc/examples/quickstart/run.sh
similarity index 100%
rename from docs/examples/quickstart/run.sh
rename to doc/examples/quickstart/run.sh
diff --git a/docs/examples/quickstart/spooling.php b/doc/examples/quickstart/spooling.php
similarity index 100%
rename from docs/examples/quickstart/spooling.php
rename to doc/examples/quickstart/spooling.php