update readme

2024-04-14 21:14:42 +01:00 · 2024-04-14 21:14:42 +01:00 · 782b63b9e1
commit 782b63b9e1
parent eb0facd38e
1 changed files with 19 additions and 1 deletions
--- 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);
+```