diff --git a/README.md b/README.md index 5d526b8..7b56f57 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,8 @@ -## This is a development build! some features may not work. +> [!WARNING] +> This is a development build! Some features may not work. ## Introduction PteroStats is a Discord Bot that designed to check Pterodactyl or Pelican Panel stats and post it to your Discord server. @@ -37,20 +38,20 @@ PteroStats is a Discord Bot that designed to check Pterodactyl or Pelican Panel If you need help, contact me on [our Discord support server](https://discord.gg/zv6maQRah3). -### Getting Panel API key +### Getting Panel API Key > [!WARNING] -> The use of Application API keys are **deprecated**, you should use **Client API keys**. +> The use of Application API keys is **deprecated**; you should use **Client API keys**. -1. Go to your `Pterodactyl or Pelican Panel` and go to `Account Page`. +1. Go to your `Pterodactyl` or `Pelican Panel` and navigate to the `Account Page`. Home -2. Click on the `API Credentials` button +2. Click on the `API Credentials` button. Account Page -3. Fill the `Description` and click on the `Create` button +3. Fill in the `Description` and click the `Create` button. Create Client API Key @@ -59,20 +60,22 @@ If you need help, contact me on [our Discord support server](https://discord.gg/ API Key ### Getting Channel ID -1. Enable Developer Feature at your discord settings + +1. Enable Developer Mode in your Discord settings. Discord User Settings -2. Right Click text channel and select `Copy ID` +2. Right-click the text channel and select `Copy ID`. Right Click Channel ### Using Custom Emoji -1. type `\` in server that has custom emoji you want + +1. Type `\` in the server that has the custom emoji you want. Type \ on the chat -2. Select custom emoji you want +2. Select the custom emoji you want. Select Custom Emoji @@ -80,24 +83,25 @@ If you need help, contact me on [our Discord support server](https://discord.gg/ Copy Emoji ID -4. Paste the emoji id at the config +4. Paste the emoji ID into the config. Status Config ### Blacklist Nodes -1. Select node from node list on admin page + +1. Select a node from the node list on the admin page. Nodes List -2. Check the url and copy the node id +2. Check the URL and copy the node ID. - Node Id + Node ID -3. Paste the id to the blacklist on config +3. Paste the ID into the blacklist in the config. Blacklist Config -You can add more than one node in the blacklist +You can add more than one node to the blacklist. Blacklist Config