Merge pull request #21 from VSEphpbb/release-prep

Release prep

Author: iMattPro

README.md

@@ -1,27 +1,34 @@
-# phpBB Skeleton Extension
+# phpBB Skeleton Extension 
+
+phpBB's Skeleton Extension is a tool for extension authors to help speed up and simplify the task of starting a new extension project. It generates sample starter files and directories in a skeleton package that you can use to begin building your extension.
 
 ## Installation
 
-To install the source code from this repository, clone this extension repository to `phpBB/ext/phpbb/skeleton`:
+- [Download the latest release](https://github.com/phpbb-extensions/phpbb-ext-skeleton/releases).
+- Unzip and install to your phpBB `ext/` folder
+- Go to "ACP" > "Customise" > "Extensions" and enable the "phpBB Skeleton Extension" extension.
+
+## Contributing
+
+To install the source code from this repository, clone the contents of this repository to `phpBB/ext/phpbb/skeleton`, then run Composer from the extension's directory:
 
-	$ git clone https://github.com/phpbb-extensions/phpbb-ext-skeleton.git
 	$ php composer.phar install
 
-Go to "ACP" > "Customise" > "Extensions" and enable the "phpBB Skeleton Extension" extension.
+## Create an Extension Skeleton
 
-## Creating an extension via web UI
+### Web-based user interface
 
 In order to create an extension via the web UI just open your board an visit the
-"Create skeleton extension" link at the top left:
+"Create skeleton extension" link in the forum's navigation bar:
 
     https://localhost/phpBB/app.php/skeleton
 
-The `.zip` is then offered as a download. Additionally it can be found at
+A packaged ZIP file is then offered as a download. Additionally it can be found in
 `store/tmp-ext/`.
 
-## Creating an extension via console
+### Command line interface
 
-In order to create an extension, you need to open the console of your server.
+In order to create an extension via the CLI, you need to open the console of your server.
 Then run the following command in your phpBB root (next to config.php):
 
     $ ./bin/phpbbcli.php extension:create

composer.json

@@ -1,17 +1,24 @@
 {
 	"name": "phpbb/skeleton",
 	"type": "phpbb-extension",
-	"description": "phpBB Extension creating extension skeletons",
-	"homepage": "https://github.com/nickv-phpbb/phpbb-ext-skeleton",
-	"version": "1.0.0-dev",
-	"time": "2015-05-29",
+	"description": "A phpBB Extension for creating extension skeletons",
+	"homepage": "https://github.com/phpbb-extensions/phpbb-ext-skeleton",
+	"version": "1.0.0-a1",
+	"time": "2016-04-04",
 	"license": "GPL-2.0",
-	"authors": [{
+	"authors": [
+		{
 			"name": "Joas Schilling",
 			"email": "nickvergessen@gmx.de",
 			"homepage": "https://github.com/nickvergessen/",
 			"role": "Lead Developer"
-		}],
+		},
+		{
+			"name": "Matt Friedman",
+			"homepage": "http://mattfriedman.me",
+			"role": "Extensions Development Team Lead"
+		}
+	],
 	"require": {
 		"php": ">=5.3.3",
 		"symfony/finder": "2.8.*"
@@ -23,6 +30,11 @@
 		"display-name": "phpBB Skeleton Extension",
 		"soft-require": {
 			"phpbb/phpbb": ">=3.1.4,<3.3.0@dev"
+		},
+		"version-check": {
+			"host": "version.phpbb.com",
+			"directory": "/phpbb-extensions",
+			"filename": "skeleton_versions.json"
 		}
 	}
 }

composer.lock

@@ -128,6 +128,9 @@ public function create_extension($data)
 		}
 		else
 		{
+			// Work-around for bug in phpBB 3.2.0-dev-3.2.0-b2
+			$cache_dir = ($this->phpbb_container->hasParameter('core.cache_dir')) ? $this->phpbb_container->getParameter('core.cache_dir') : $this->phpbb_container->getParameter('core.root_path') . 'cache/';
+
 			$template_engine = new twig(
 				$this->phpbb_container->get('path_helper'),
 				$config,
@@ -137,13 +140,13 @@ public function create_extension($data)
 					$this->phpbb_container->get('filesystem'),
 					$this->phpbb_container->get('path_helper'),
 					$this->phpbb_container,
-					$this->phpbb_container->getParameter('core.cache_dir'),
+					$cache_dir,
 					$this->phpbb_container->get('ext.manager'),
 					new loader(
 						new \phpbb\filesystem\filesystem()
 					)
 				),
-				$this->phpbb_container->getParameter('core.cache_dir'),
+				$cache_dir,
 				$this->phpbb_container->get('user')
 			);
 		}