diff --git a/readme.md b/readme.md index a5ea7cac7..c81782e1e 100644 --- a/readme.md +++ b/readme.md @@ -2,21 +2,29 @@ # Pelican Panel +**Fly High, Game On: Pelican's pledge for unrivaled game servers.** + ![Total Downloads](https://img.shields.io/github/downloads/pelican-dev/panel/total?style=flat&label=Total%20Downloads&labelColor=rgba(0%2C%2070%2C%20114%2C%201)&color=rgba(255%2C%20255%2C%20255%2C%201)) ![Latest Release](https://img.shields.io/github/v/release/pelican-dev/panel?style=flat&label=Latest%20Release&labelColor=rgba(0%2C%2070%2C%20114%2C%201)&color=rgba(255%2C%20255%2C%20255%2C%201)) -Pelican Panel is an open-source, web-based application designed for easy management of game servers. -It offers a user-friendly interface for deploying, configuring, and managing servers, with features like real-time resource monitoring, Docker container isolation, and extensive customization options. -Ideal for both individual gamers and hosting companies, it simplifies server administration without requiring deep technical knowledge. +Pelican Panel is a free, open-source game server control panel built for communities, hosts, and self-hosters. +It gives users a modern web UI for creating and managing game servers while running each server in an isolated Docker container through Wings. -Fly High, Game On: Pelican's pledge for unrivaled game servers. +## Why Pelican? -## Links +Use Pelican if you want: +- A modern alternative in the Pterodactyl ecosystem +- Docker-isolated game servers +- Support for Minecraft, SteamCMD games, databases, bots, voice servers, and more +- A free, open-source panel suitable for personal servers, communities, and hosting providers -* [Website](https://pelican.dev) -* [Docs](https://pelican.dev/docs) -* [Discord](https://discord.gg/pelican-panel) +## Support + +* [Read the documentation](https://pelican.dev/docs) +* [Join the Discord](https://discord.gg/pelican-panel) * [Wings](https://github.com/pelican-dev/wings) +* [Open a GitHub Discussion for general project questions](https://github.com/pelican-dev/panel/discussions) +* [Open an Issue for confirmed bugs](https://github.com/pelican-dev/panel/issues) ## Supported Games and Servers @@ -41,6 +49,26 @@ Some of our popular eggs include: | [Storage](https://github.com/pelican-eggs/storage) | S3 | SFTP Share | | | | [Monitoring](https://github.com/pelican-eggs/monitoring) | Prometheus | Loki | | | +## Contributing + +We welcome contributions from developers, designers, translators, testers, documentation writers, and egg maintainers. + +Good places to start: + +- Read `contributing.md` +- Browse open issues +- Join Discord and ask where help is needed +- Improve docs or submit egg updates + +## Supporting the Project + +Pelican is built and maintained by volunteers. If Pelican helps you or your community, consider supporting ongoing development: + +- [Sponsor the project](https://hub.pelican.dev/sponsor) +- [Contribute code or documentation](https://github.com/pelican-dev/panel) +- [Help answer questions in Discord](https://discord.com/channels/1218730176297439332/1219038617133912084) +- Share Pelican with other server owners + ## Repository Activity ![Stats](https://repobeats.axiom.co/api/embed/4d8cc7012b325141e6fae9c34a22b3669ad5753b.svg "Repobeats analytics image")