Merge pull request #26 from VSEphpbb/release-alpha

Update README and composer for 1.0.0-a1

README.md

@@ -5,4 +5,25 @@ This is the repository for the development of the Collapsible Categories Extensi
 [![Build Status](https://travis-ci.org/phpbb-extensions/collapsible-categories.png)](https://travis-ci.org/phpbb-extensions/collapsible-categories)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/phpbb-extensions/collapsible-categories/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/phpbb-extensions/collapsible-categories/?branch=master)
 
-Extension is currently under development and is not ready to install on any forum. No support will be given until the first release version is anounced. Watch this space for any news!
+## Quick Install
+You can install this on the latest release of phpBB 3.1 by following the steps below:
+
+1. [Download the latest release](https://github.com/phpbb-extensions/collapsible-categories/releases).
+2. Unzip the downloaded release and copy it to the `ext` directory of your phpBB board.
+3. Navigate in the ACP to `Customise -> Manage extensions`.
+4. Look for `Collapsible Forum Categories` under the Disabled Extensions list, and click its `Enable` link.
+
+## Uninstall
+
+1. Navigate in the ACP to `Customise -> Extension Management -> Extensions`.
+2. Look for `Collapsible Forum Categories` under the Enabled Extensions list, and click its `Disable` link.
+3. To permanently uninstall, click `Delete Data` and then delete the `/ext/phpbb/collapsiblecategories` directory.
+
+## Support
+
+* **Important: Only official release versions validated by the phpBB Extensions Team should be installed on a live forum. Pre-release (alpha, beta, RC) versions downloaded from this repository are only to be used for testing on offline/development forums and are not officially supported.**
+* Report bugs and other issues to our [Issue Tracker](https://github.com/phpbb-extensions/collapsible-categories/issues).
+* Support requests should be posted and discussed in the [Collapsible Forum Categories topic at phpBB.com](https://www.phpbb.com/community/viewtopic.php?f=456&t=2311981).
+
+## License
+[GNU General Public License v2](http://opensource.org/licenses/GPL-2.0)

composer.json

@@ -1,9 +1,9 @@
 {
 	"name": "phpbb/collapsiblecategories",
 	"type": "phpbb-extension",
-	"description": "An extension for phpBB that allows users to collapse and hide forum categories with a simple click.",
+	"description": "An extension for phpBB that allows visitors to collapse and minimise forum categories with a simple click.",
 	"homepage": "https://www.phpbb.com",
-	"version": "1.0.0-dev",
+	"version": "1.0.0-a1",
 	"license": "GPL-2.0",
 	"authors": [
 		{
@@ -45,7 +45,12 @@
 	"extra": {
 		"display-name": "Collapsible Forum Categories",
 		"soft-require": {
-			"phpbb/phpbb": ">=3.1.2,<3.2.*@dev"
+			"phpbb/phpbb": ">=3.1.3,<3.2.*@dev"
+		},
+		"version-check": {
+			"host": "version.phpbb.com",
+			"directory": "/phpbb-extensions",
+			"filename": "collapsible_categories_versions.json"
 		}
 	}
 }