diff --git a/README.md b/README.md index f56e736..ae61153 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,35 @@ -# Alpha Project -Please refrain from opening PRs or Issues at this time. This project is still under heavy development, and until we have a solid foundation and plan for how everything will connect, we will not be accepting PRs or feature suggestions. +[![Logo Image](https://cdn.pterodactyl.io/logos/new/pterodactyl_logo.png)](https://pterodactyl.io) -# Pterodactyl wings [![travis](https://img.shields.io/travis/pterodactyl/wings.svg?style=flat-square)](https://travis-ci.org/pterodactyl/wings) [![codacy quality](https://img.shields.io/codacy/grade/27a1576bda86450f853b1052b12fa570.svg?style=flat-square)](https://www.codacy.com/app/schrej/wings/dashboard) [![codacy coverage](https://img.shields.io/codacy/coverage/27a1576bda86450f853b1052b12fa570.svg?style=flat-square)](https://www.codacy.com/app/schrej/wings/files) +[![Discord](https://img.shields.io/discord/122900397965705216.svg?style=flat-square&label=Discord)](https://pterodactyl.io/discord) -``` - ____ -__ Pterodactyl _____/___/_______ _______ ______ -\_____\ \/\/ / / / __ / ___/ - \___\ / / / / /_/ /___ / - \___/\___/___/___/___/___ /______/ - /_______/ alpha -``` +# Pterodactyl Wings +Wings is Pterodactyl's server control plane, built for the rapidly changing gaming industry and designed to be +highly performant and secure. Wings provides an HTTP API allowing you to interface directly with running server +instances, fetch server logs, generate backups, and control all aspects of the server lifecycle. -A new generation of the Pterodactyl daemon, written in go. +In addition, Wings ships with a built-in SFTP server allowing your system to remain free of Pterodactyl specific +dependencies, and allowing users to authenticate with the same credentials they would normally use to access the Panel. +## Sponsors +I would like to extend my sincere thanks to the following sponsors for helping find Pterodactyl's developement. +[Interested in becoming a sponsor?](https://github.com/sponsors/DaneEveritt) + +| Company | About | +| ------- | ----- | +| [**BloomVPS**](https://bloomvps.com) | BloomVPS offers dedicated core VPS and Minecraft hosting with Ryzen 9 processors. With owned-hardware, we offer truly unbeatable prices on high-performance hosting. | +| [**VersatileNode**](https://versatilenode.com/) | Looking to host a minecraft server, vps, or a website? VersatileNode is one of the most affordable hosting providers to provide quality yet cheap services with incredible support. | +| [**MineStrator**](https://minestrator.com/) | Looking for a French highend hosting company for you minecraft server? More than 14,000 members on our discord, trust us. | +| [**DedicatedMC**](https://dedicatedmc.io/) | DedicatedMC provides Raw Power hosting at affordable pricing, making sure to never compromise on your performance and giving you the best performance money can buy. | +| [**Skynode**](https://www.skynode.pro/) | Skynode provides blazing fast game servers along with a top-notch user experience. Whatever our clients are looking for, we're able to provide it! | +| [**XCORE-SERVER.de**](https://xcore-server.de/) | XCORE-SERVER.de offers High-End Servers for hosting and gaming since 2012. Fast, excellent and well-known for eSports Gaming. | + +## Documentation +* [Panel Documentation](https://pterodactyl.io/panel/1.0/getting_started.html) +* [Wings Documentation](https://pterodactyl.io/wings/1.0/installing.html) +* [Community Guides](https://pterodactyl.io/community/about.html) +* Or, get additional help [via Discord](https://discord.gg/pterodactyl) + +## Reporting Issues +Please use the [pterodactyl/panel](https://github.com/pterodactyl/panel) repository to report any issues or make +feature requests for Wings. In addition, the [security policy](https://github.com/pterodactyl/panel/security/policy) listed +within that repository also applies to Wings. \ No newline at end of file