updating doc

marayshi · Jan 3, 2016 · daca0fd · daca0fd
1 parent 0b3a35d
commit daca0fd
Show file tree

Hide file tree

Showing 11 changed files with 7 additions and 2 deletions.
diff --git 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 → doc/examples/mock/MyPAGIApplication.php b/docs/examples/mock/MyPAGIApplication.php → doc/examples/mock/MyPAGIApplication.php
diff --git a/docs/examples/mock/mocktest.php → doc/examples/mock/mocktest.php b/docs/examples/mock/mocktest.php → doc/examples/mock/mocktest.php
diff --git a/docs/examples/node/example.php → doc/examples/node/example.php b/docs/examples/node/example.php → doc/examples/node/example.php
diff --git a/docs/examples/node/run.php → doc/examples/node/run.php b/docs/examples/node/run.php → doc/examples/node/run.php
diff --git a/docs/examples/node/test_example.php → doc/examples/node/test_example.php b/docs/examples/node/test_example.php → doc/examples/node/test_example.php
diff --git a/docs/examples/nodecontroller/example.php → doc/examples/nodecontroller/example.php b/docs/examples/nodecontroller/example.php → doc/examples/nodecontroller/example.php
diff --git a/docs/examples/nodecontroller/run.php → doc/examples/nodecontroller/run.php b/docs/examples/nodecontroller/run.php → doc/examples/nodecontroller/run.php
diff --git a/...examples/quickstart/MyPAGIApplication.php → ...examples/quickstart/MyPAGIApplication.php b/...examples/quickstart/MyPAGIApplication.php → ...examples/quickstart/MyPAGIApplication.php
diff --git a/docs/examples/quickstart/run.sh → doc/examples/quickstart/run.sh b/docs/examples/quickstart/run.sh → doc/examples/quickstart/run.sh
diff --git a/docs/examples/quickstart/spooling.php → doc/examples/quickstart/spooling.php b/docs/examples/quickstart/spooling.php → doc/examples/quickstart/spooling.php