Update README.md
This commit is contained in:
parent
436c9be3e5
commit
c625a70a59
30
README.md
30
README.md
@ -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.
|
Loading…
Reference in New Issue
Block a user