diff --git a/README.md b/README.md index 9eb7b302e..3764512e4 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,32 @@ -# [![PocketMine-MP](http://cdn.pocketmine.net/img/PocketMine-MP-h.png)](https://pmmp.io) - -__A highly customisable, open source server software for Minecraft: Bedrock Edition written in PHP__ +

+
+ A highly customisable, open source server software for Minecraft: Bedrock Edition written in PHP +

[![Build Status](https://travis-ci.org/pmmp/PocketMine-MP.svg?branch=master)](https://travis-ci.org/pmmp/PocketMine-MP) -### Setup, help & support, FAQs -Head over to the [documentation site](http://pmmp.readthedocs.org/). -If you don't find what you're looking for there, [talk to a human](#discussion). Please do not use our issue tracker for support requests. - -### Docker -We provide an official docker image on Docker Hub: [`pmmp/pocketmine-mp`](https://hub.docker.com/r/pmmp/pocketmine-mp). +### Getting started +- [Documentation](http://pmmp.readthedocs.org/) +- [Installation instructions](https://pmmp.readthedocs.io/en/rtfd/installation.html) +- [Docker image](https://hub.docker.com/r/pmmp/pocketmine-mp) +- [Plugin repository](https://poggit.pmmp.io) ### Discussion - [Forums](https://forums.pmmp.io/) - [Community Discord](https://discord.gg/bge7dYQ) -### Plugins -There are a very wide range of already-written plugins available which you can use to customise your server. Check out [Poggit](https://poggit.pmmp.io), or just search GitHub. - ### For developers * [Latest API documentation](https://jenkins.pmmp.io/job/PocketMine-MP-doc/doxygen/) - Doxygen documentation generated from development * [DevTools](https://github.com/pmmp/PocketMine-DevTools/) - Development tools plugin for creating plugins * [ExamplePlugin](https://github.com/pmmp/ExamplePlugin/) - Example plugin demonstrating some basic API features - -### Can I contribute? -Yes you can! Contributions are welcomed provided that they comply with our [Contributing Guidelines](CONTRIBUTING.md). Please ensure you read the relevant sections of the guidelines carefully before making a Pull Request or opening an Issue. - -### Where can I get the latest .phar? -- Latest release builds can be found in our [GitHub releases](https://github.com/pmmp/PocketMine-MP/releases). -- Latest bleeding-edge development builds (and other builds in the build job channels) can be found on our [Jenkins server](https://jenkins.pmmp.io/). - -**Note: Please avoid development builds unless there is no other alternative for what you need.** Development builds are subject to changes at any time without notice, and it is likely that your server or plugins might break without warning. + * [Contributing Guidelines](CONTRIBUTING.md) ### Donate -Donations help support the development of the project and pay for our expenses. - Bitcoin Cash (BCH): `qz9p8dqkv0r7aahdatu5uewqfkvstrglv58f8yle07` - Bitcoin (BTC): `1PVAyDJ2g7kcjCxAC3C89oxpV2ZYcLad8T` - [Patreon](https://www.patreon.com/pocketminemp) ## Licensing information - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Lesser General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public License - along with this program. If not, see . +This project is licensed under LGPL-3.0. Please see the [LICENSE](/LICENSE) file for details. pmmp/PocketMine are not affiliated with Mojang. All brands and trademarks belong to their respective owners. PocketMine-MP is not a Mojang-approved software, nor is it associated with Mojang.