From ea7cd56eb9fa347b98c66074b1fa236c9e0cee10 Mon Sep 17 00:00:00 2001
From: Andy Wang <41224501+andy-t-wang@users.noreply.github.com>
Date: Fri, 25 Oct 2024 11:36:04 -0400
Subject: [PATCH] readme (#86)

---
 README.md | 25 ++++++++++++++++++++-----
 1 file changed, 20 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 008be5d..fd03de8 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,23 @@
-# minikit-js
-MiniKit - SDK for Mini Apps in World App.
+# Minikit-JS
 
-Make sure to turbo build inside of `/src` folder to reflect any changes in the Demo
+## 🚀 Getting Started
 
+Minikit is currently available on npm. To install, run:
+`pnpm i @worldcoin/minikit-js`
+
+or use the CDN:
+`https://cdn.jsdelivr.net/npm/@worldcoin/minikit-js@[version]/+esm`
+
+For comprehensive setup instructions and usage examples, visit our [developer documentation](https://docs.world.org/mini-apps).
+
+## 🛠 ️Developing Locally
+
+To run the example mini app locally:
+
+```
+pnpm i
+cd demo/with-next
+pnpm dev
 ```
-turbo build 
-```
\ No newline at end of file
+
+This will launch a demo mini app with all essential commands implemented, allowing you to explore and test the features.