From 782b63b9e175452a3b2ecd272be390ba650526b5 Mon Sep 17 00:00:00 2001 From: Liam Date: Sun, 14 Apr 2024 21:14:42 +0100 Subject: [PATCH] update readme --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 07a024c..fa16112 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ -# Javascript-Library +# Minecraft Utilities - Javascript Library +The JavaScript library for the Minecraft Utilities API. + +## Usage + +Install the package using npm: + +```bash +npm install mcutils-library +``` + +Fetch data from a player: + +```javascript +import mcUtils from "mcutils-library"; + +const { player } = await mcUtils.getPlayer("Notch"); +console.log(player); +```