mcstatus-sdk
v1.0.1
Published
A Node.js client SDK for interacting with the Minecraft server status API at [mcstatus.js.org](https://mcstatus.js.org).
Downloads
7
Readme
mcstatus-sdk
A Node.js client SDK for interacting with the Minecraft server status API at mcstatus.js.org.
Installation
Install the SDK via npm:
npm install mcstatus-sdk
Usage
Import the mcstatus-sdk module and use the ServerStatus class to interact with the API.
Example:
const ServerStatus = require('mcstatus-sdk');
const client = new ServerStatus();
async function checkStatus() {
const javaStatus = await client.getJavaStatus('example.com');
console.log(javaStatus);
const bedrockStatus = await client.getBedrockStatus('example.com');
console.log(bedrockStatus);
const icon = await client.getServerIcon('example.com');
console.log(icon);
}
checkStatus();
API Documentation
This SDK interacts with the API at mcstatus.js.org. Full API documentation is available at mcstatus.js.org/api/docs.
License
This project is licensed under the MIT License.
This version simplifies the `README.md` by directing users to your API documentation. Let me know if this works!