diff --git a/README.md b/README.md index baa8662..f0b40c4 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,30 @@ -boardannouncements -================== +# phpBB Board Announcements Extension + +This is the repository for the development of the phpBB Board Announcements Extension. + +[![Build Status](https://travis-ci.org/phpbb-extensions/boardannouncements.png)](https://travis-ci.org/phpbb-extensions/boardannouncements) + +## Quick Install +You can install this on the latest copy of the develop branch ([phpBB 3.1-dev](https://github.com/phpbb/phpbb3)) by following the steps below: + +1. [Download the latest release](https://github.com/phpbb-extensions/boardannouncements/releases). +2. Unzip the downloaded release, and change the name of the folder to `boardannouncements`. +3. In the `ext` directory of your phpBB board, create a new directory named `phpbb` (if it does not already exist). +4. Copy the `boardannouncements` folder to `phpBB/ext/phpbb/` (if done correctly, you'll have the main extension class at (your forum root)/ext/phpbb/boardannouncements/ext.php). +5. Navigate in the ACP to `Customise -> Manage extensions`. +6. Look for `Board Announcements` under the Disabled Extensions list, and click its `Enable` link. +7. Set up and configure Board Announcements by navigating in the ACP to `Extensions` -> `Board Announcements`. + +## Uninstall + +1. Navigate in the ACP to `Customise -> Extension Management -> Extensions`. +2. Look for `Board Announcements` under the Enabled Extensions list, and click its `Disable` link. +3. To permanently uninstall, click `Delete Data` and then delete the `/ext/phpbb/boardannouncements` folder. + +## Support + +* Report bugs and other issues to our [Issue Tracker](https://github.com/phpbb-extensions/boardannouncements/issues). +* Support requests should be posted and discussed in the [Board Announcements topic at phpBB.com](https://www.phpbb.com/community/viewtopic.php?f=456&t=2245901). + +## License +[GNU General Public License v2](http://opensource.org/licenses/GPL-2.0) diff --git a/composer.json b/composer.json index 5e84fe0..998d367 100644 --- a/composer.json +++ b/composer.json @@ -3,7 +3,7 @@ "type": "phpbb-extension", "description": "An extension which allows you to create board-wide announcements for your phpBB forum", "homepage": "https://phpbb.com", - "version": "1.0.0-dev", + "version": "1.0.0-b1", "keywords": ["phpbb", "extension", "announcements"], "license": "GPL-2.0", "authors": [ @@ -13,6 +13,19 @@ "email": "nathaniel.guse@gmail.com", "role": "Extensions Development Team Lead" }, + { + "name": "Michael Cullum", + "homepage": "http://michaelcullum.com", + "email": "michael@phpbb.com", + "role": "Extensions Team Consultant" + }, + { + "name": "Marc Alexander", + "username": "Marc", + "email": "admin@m-a-styles.de", + "homepage": "http://www.m-a-styles.de", + "role": "Extensions Team Consultant" + }, { "name": "Matt Friedman", "username": "VSE", @@ -30,6 +43,11 @@ "phpbb/phpbb": "3.1.*@dev" }, "extra": { - "display-name": "Board Announcements" + "display-name": "Board Announcements", + "version-check": { + "host": "version.phpbb.com", + "directory": "/phpbb-extensions", + "filename": "boardannouncements_versions.json" + } } } diff --git a/tests/functional/version_check_test.php b/tests/functional/version_check_test.php index 73344ed..02383af 100644 --- a/tests/functional/version_check_test.php +++ b/tests/functional/version_check_test.php @@ -33,8 +33,6 @@ static protected function setup_extensions() */ public function test_version_check() { - $this->markTestSkipped('Version info file is not available yet'); - // Load our language files $this->add_lang_ext('phpbb/boardannouncements', array('info_acp_board_announcements'));