README.md
# phpBB Board Rules Extension
This is the repository for the development of the phpBB Board Rules Extension.
[![Build Status](https://github.com/phpbb-extensions/boardrules/workflows/Tests/badge.svg)](https://github.com/phpbb-extensions/boardrules/actions)
[![codecov](https://codecov.io/gh/phpbb-extensions/boardrules/graph/badge.svg?token=YetAXFXZyQ)](https://codecov.io/gh/phpbb-extensions/boardrules)
[![Code Climate](https://codeclimate.com/github/phpbb-extensions/boardrules/badges/gpa.svg)](https://codeclimate.com/github/phpbb-extensions/boardrules)
## Install
1. [Download the latest validated release](https://www.phpbb.com/customise/db/extension/boardrules/).
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 `Board Rules` under the Disabled Extensions list, and click its `Enable` link.
5. Set up and configure Board Rules by navigating in the ACP to `Extensions` -> `Board Rules`.
## Uninstall
1. Navigate in the ACP to `Customise -> Extension Management -> Extensions`.
2. Look for `Board Rules` under the Enabled Extensions list, and click its `Disable` link.
3. To permanently uninstall, click `Delete Data` and then delete the `/ext/phpbb/boardrules` directory.
## Support
* **Important: Only official release versions validated by the phpBB Extensions Team should be installed on a live forum. Pre-release (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/boardrules/issues).
* Support requests should be posted and discussed in the [Board Rules topic at phpBB.com](https://www.phpbb.com/customise/db/extension/boardrules/support).
## Translations
* Translations should be posted to the [Board Rules topic at phpBB.com](https://www.phpbb.com/customise/db/extension/boardrules/support/topic/130746). We accept pull requests for translation corrections, but we do not accept pull requests for new translations.
## License
[GNU General Public License v2](https://opensource.org/licenses/GPL-2.0)