Add docs/getting-started.md and refocus the project description on th…

…e WebUI instead of Console

.php_cs

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

README.md

@@ -6,7 +6,10 @@ Noiselabs ZfDebugModule
 [![Code Coverage](https://scrutinizer-ci.com/g/noiselabs/zf-debug-utils/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/noiselabs/zf-debug-utils/?branch=master)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/noiselabs/zf-debug-utils/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/noiselabs/zf-debug-utils/?branch=master)
 
-Console commands and other utilities for debugging ZF2 apps.
+WebUI and Console commands for debugging ZF2 apps.
+
+    DISCLAIMER: ZfDebugModule is still at an early development stage.
+    No Console commands were added so far.
 
 Installation
 ------------
@@ -31,7 +34,9 @@ Then enable this module by adding it and `AssetManager` (a dependency) to `appli
 Documentation
 -------------
 
+Documentation is available on Read the Docs: <https://zf-debug-utils.readthedocs.org/>
 
+* [Getting Started](getting-started.md)
 
 License
 -------

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "noiselabs/zf-debug-utils",
-    "description": "Console commands and other utilities for debugging ZF2 apps",
+    "description": "WebUI and Console commands for debugging ZF2 apps",
     "type": "library",
     "license": "MIT",
     "authors": [

docs/conf.py

@@ -7,7 +7,7 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath('..'))
-import recommonmark
+
 from recommonmark.transform import AutoStructify
 from recommonmark.parser import CommonMarkParser
 
@@ -21,6 +21,7 @@
 
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinx.ext.todo',
 ]
 
 templates_path = ['_templates']
@@ -30,19 +31,30 @@
 
 # General information about the project.
 project = u'Noiselabs ZfDebugModule'
-copyright = u'2016, Vítor Brandão and contributors'
+copyright = u'2016, Vítor Brandão'
 author = u'Vítor Brandão and contributors'
+version = '0.2'
+release = '0.2.0-DEV'
 
 exclude_patterns = ['_build']
 pygments_style = 'sphinx'
+todo_include_todos = True
 html_theme = 'sphinx_rtd_theme'
 html_static_path = ['_static']
+html_domain_indices = True
+html_use_index = True
+html_show_sphinx = True
+html_show_copyright = True
+html_file_suffix = None
+html_search_language = 'en'
+htmlhelp_basename = 'zf-debug-utils'
 
 github_doc_root = 'https://github.com/noiselabs/zf-debug-utils/tree/master/docs'
 
 def setup(app):
     app.add_config_value('recommonmark_config', {
             'url_resolver': lambda url: github_doc_root + url,
             'auto_toc_tree_section': 'Contents',
+            'enable_auto_doc_ref': True,
             }, True)
     app.add_transform(AutoStructify)

docs/getting-started.md

@@ -0,0 +1,65 @@
+Getting Started
+===============
+
+Installation
+------------
+
+Install the package via Composer:
+
+```bash
+composer require noiselabs/zf-debug-utils
+```
+
+
+Then enable this module by adding it and `AssetManager` (a dependency) to `application.config.php`.
+
+```php
+<?php
+'modules' => [
+    'AssetManager',
+    'Noiselabs\ZfDebugModule',
+],
+```
+
+Configuration
+-------------
+
+Nothing so far. It just works. Soon we will add the possibility of defining a custom root URL for ZfDebugModule URLs.
+
+What's inside?
+--------------
+
+ZfDebugModule provides a _WebUI and Console commands for debugging ZF2 apps_. However, as stated in the DISCLAIMER:
+ _"ZfDebugModule is still at an early development stage. No Console commands were added so far"_. So for now we are
+ going to focus on WebUI features only.
+
+### WebUI
+
+Web URLs are by default mounted at `/_debug`. After installing this module simply navigate to `/_debug` and you should
+see the home screen. If you are using the ZendSkeletonApplication the home URL should look similar to this:
+ `http://127.0.0.1:8080/_debug`.
+
+### Routing
+
+Routing is the first debug component made available. You have the possibility to list all routes or match a URL to a
+route.
+
+![Home - Routing](_static/images/index-routing.png "Home - Routing")
+
+#### List all Routes
+
+Navigate to `/_debug/routes/list` or in the Home screen click in `List all Routes`. These are all the routes available
+ in current application. Each column is sortable and you can filter results by using the search input.
+
+![List all routes](_static/images/routing-list-all-routes.png "List all routes")
+
+#### Match a Route 
+
+Navigate to `/_debug/routes/match` or in the Home screen click in `Match a Route`. Provide an HTTP method such as "GET"
+or "POST" plus a base URL (omit the scheme) and hit `Find Route`. If the URL matches a route in your application you
+ should see something similar to the following picture. You can see details such as the route URL, controller and action.
+
+![Match a Route](_static/images/routing-match-route.png "Match a Route")
+
+
+

src/Controller/Console/RoutesController.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

src/Controller/Http/IndexController.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

src/Controller/Http/RoutesController.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

src/Factory/Controller/Console/RoutesControllerFactory.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

src/Factory/Controller/Http/IndexControllerFactory.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

src/Factory/Controller/Http/RoutesControllerFactory.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

src/Factory/Util/Routing/RouteCollectionFactory.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

src/Factory/Util/Routing/RouteMatcherFactory.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

src/Module.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

src/Package.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>
@@ -16,6 +16,6 @@ class Package
     const VENDOR = 'noiselabs';
     const NAME = 'zf-debug-utils';
     const FQPN = 'noiselabs/zf-debug-utils'; // Fully Qualified Package Name
-    const DESCRIPTION = 'Console commands and other utilities for debugging ZF2 apps';
+    const DESCRIPTION = 'WebUI and Console commands for debugging ZF2 apps';
     const VERSION = '0.2.0-DEV';
 }

src/Resources/config/module.config.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

src/Resources/public/js/main.js

@@ -1,5 +1,5 @@
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

src/Util/Routing/FlatRouteCollection.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

src/Util/Routing/Route.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

src/Util/Routing/RouteCollection.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

src/Util/Routing/RouteCollectionBuilder.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

src/Util/Routing/RouteMatcher.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

test/Functional/Bootstrap.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

test/Functional/Controller/Console/RoutesControllerTest.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

test/Functional/Controller/Http/IndexControllerTest.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

test/Functional/Controller/Http/RoutesControllerTest.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

test/Functional/config/application.config.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

test/Unit/Factory/Controller/Console/RoutesControllerFactoryTest.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

test/Unit/Factory/Controller/Http/IndexControllerFactoryTest.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

test/Unit/Factory/Controller/Http/RoutesControllerFactoryTest.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

test/Unit/Factory/Util/Routing/RouteCollectionFactoryTest.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

test/Unit/Factory/Util/Routing/RouteMatcherFactoryTest.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

test/Unit/ModuleTest.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>

test/Unit/PackageTest.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ZfDebugModule. Console commands and other utilities for debugging ZF2 apps.
+ * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
  *
  * @license http://www.opensource.org/licenses/mit-license.html MIT License
  * @copyright 2016 Vítor Brandão <vitor@noiselabs.org>