Javascript-Library/README.md
Liam cbb534adf4
Some checks failed
Publish Package / build (push) Failing after 20s
update readme
2024-04-17 17:51:39 +01:00

32 lines
546 B
Markdown

# Minecraft Utilities - Javascript Library
The JavaScript library for the Minecraft Utilities API.
## Usage
Install the package using npm:
```bash
npm install mcutils-library
```
Get player:
```javascript
import { getPlayer, CachedPlayer } from "mcutils-library";
const cachedPlayer = await getPlayer(playerId);
console.log(player);
```
Get Server:
```javascript
import { getServer, CachedJavaMinecraftServer } from "mcutils-library";
const cachedServer = await getServer(ServerPlatform.Java, "hypixel.net");
console.log(server);
```