[WIP] Add additional structure and comments to create more of a skeleton

Module.php

@@ -12,6 +12,11 @@
 use Zend\ModuleManager\Feature\AutoloaderProviderInterface;
 use Zend\Mvc\ModuleRouteListener;
 
+/**
+ * Short Description of module
+ *
+ * Long Description of module
+ */
 class Module implements AutoloaderProviderInterface
 {
     public function getAutoloaderConfig()
@@ -33,12 +38,22 @@ public function getConfig()
         return include __DIR__ . '/config/module.config.php';
     }
 
-    public function onBootstrap($e)
+    public function onBootstrap($event)
     {
         // You may not need to do this if you're doing it elsewhere in your
         // application
-        $eventManager        = $e->getApplication()->getEventManager();
+        $eventManager        = $event->getApplication()->getEventManager();
         $moduleRouteListener = new ModuleRouteListener();
         $moduleRouteListener->attach($eventManager);
     }
+
+/*
+    public function init($moduleManager)
+    {
+        // Any module dependencies your module relies on could be placed here
+	// load will throw an exception if the module can't be loaded
+        // $moduleManager->load('someModule');
+
+    }
+*/
 }

README.md

@@ -1 +1 @@
-Sample, skeleton module for use with the ZF2 MVC layer.
+Sample skeleton module for use with the ZF2 MVC layer.

config/module.config.php

@@ -1,10 +1,17 @@
 <?php
 return array(
+    // as the configuration is one large array, place your module specific
+    // config inside a key unique to your module.
+    'zend_skeleton_module' => array(
+
+    ),
+    // controller config
     'controllers' => array(
         'invokables' => array(
             'skeleton' => 'ZendSkeletonModule\Controller\SkeletonController',
         ),
     ),
+    // define any routes the module needs
     'router' => array(
         'routes' => array(
             'module-name-here' => array(
@@ -42,6 +49,7 @@
             ),
         ),
     ),
+    // define options for the view manager
     'view_manager' => array(
         'template_path_stack' => array(
             'ZendSkeletonModule' => __DIR__ . '/../view',

data/README.md

@@ -0,0 +1,22 @@
+
+Data Directory
+=================
+
+Sql files for your module can be placed here with a filename: "name.dbtype.sql"
+
+name: The name can be anything. It's suggested you use the name 'schema' for sql files
+which create compulsory sql, and any other name for optional sql code.
+
+dbtype: This denotes what engine the sql code is for:
+  sqlite
+  mysql
+  postgresql
+  sqlserver
+  sql92
+
+Examples
+---------
+
+ * schema.mysql.sql        compulsory sql code that the modules needs to run
+
+ * featurefoo.sqlite.sql   optional sql code for sqlite which the module can use to add extra feature/s

public/README.md

@@ -0,0 +1,6 @@
+
+Public
+========
+
+This directory is for the benefit of the users of your module. Place files you need for public web access 
+inside here with the structure you need. Users can either symlink / copy files as necessary.

public/css/README.md

@@ -0,0 +1,5 @@
+
+CSS Files
+==========
+
+Place CSS files here

public/js/README.md

@@ -0,0 +1,5 @@
+
+js
+====
+
+Place javascript files in here