diff --git a/README.md b/README.md index 86866d9..179b3e0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

PteroJS

A verbose API library for Pterodactyl

-

+

## About PteroJS is a verbose API library for the [Pterodactyl Game Panel](https://pterodactyl.io) designed to give developers full access and control over the API without having to compromise on code quality or efficiency. @@ -21,12 +21,15 @@ import pterojs from 'https://cdn.skypack.dev/@devnote-dev/pterojs'; Please join the [support server](https://discord.com/invite/dwcfTjgn7S) if you experience any issues with installing the package. ## Compatibility +Note that you can use older versions of PteroJS with newer versions of Pterodactyl and Wings, but they will not be up-to-date with the latest features and fixes. + PteroJS | Panel | Wings --------|-------|------ ❌ | `<= 0.7` | `<= 1.5` `1.3.0` | `1.6.5 >= 1.7.0` | `~1.6.0` `1.4.2` | `1.7.0 >= 1.8.1` | `~1.6.0` `2.0.1` | `^1.9.0` | `^1.7.0` +`2.1.0` | `^1.10.0` | `^1.7.0` ## Setting Up PteroJS uses separate classes for the client and application sides of the Pterodactyl API. @@ -39,7 +42,7 @@ const { PteroApp } = require('@devnote-dev/pterojs'); const app = new PteroApp('your.domain.name', 'pterodactyl_api_key'); // Accessing information -app.servers.fetch('evuk98yu').then(console.log); +app.servers.fetch('f7eca02e').then(console.log); ``` ### Using the client API @@ -47,14 +50,10 @@ app.servers.fetch('evuk98yu').then(console.log); const { PteroClient } = require('@devnote-dev/pterojs'); // Initialising the client -const client = new PteroClient( - 'your.domain.name', - 'pterodactyl_api_key', - { ws: true } -); +const client = new PteroClient('your.domain.name', 'pterodactyl_api_key'); // Adding the server to listen for -const shard = client.addSocksetServer('kgujg66h'); +const shard = client.addSocksetServer('f7eca02e'); // Listening to events shard.on('statusUpdate', status => { diff --git a/package.json b/package.json index 6d7bae2..c7b49dd 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@devnote-dev/pterojs", - "version": "2.0.1", + "version": "2.1.0", "description": "A verbose API library for Pterodactyl", "author": "Devonte ", "contributors": [