MinecraftUtilities/Javascript-Library
1
0
Fork 0
Code Issues 1 Pull Requests 5 Actions Activity

Update README.md

Browse Source
This commit is contained in:
Lee 2024-04-20 01:13:13 +00:00
parent 436c9be3e5
commit c625a70a59
1 changed files with 1 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,31 +1,3 @@
# 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);
```
See [The Website](https://mcutils.xyz) or [Minecraft Utilities Documentation](https://mcutils.xyz/documentation) for more information.