diff --git a/README.md b/README.md index b2e86e7..d4e9a84 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,27 @@ -## PteroStats +## PteroStats (1.0) -a Discord Bot that check panel, nodes and databases status +## Introduction + +PteroStata is a bot designed to check Panel, Nodes, and Databases status and post it to discord server + +* Written in Javascript, CloudServer is faster and more stable. +* PteroControl can be used with any server on Pterodactyl, irregardless of whether it's on shared hosting or your own hosted panel + +PteroStats is still **under development** and we welcome contributions. + +Links +-------------------- + +* __[Discord](https://discord.gg/9Z7zpdwATZ)__ + +Installation +-------------------- + +- `fill in the required informations in the config.json file` +- `Run npm install in the root directory of the bot files` +- `Run node index.js and you are done` + +Need Help Setuping? +-------------------- + +Contact me at discord server or dm Hirzi#8701