Skip to content

Commit

Permalink
readme (#86)
Browse files Browse the repository at this point in the history
  • Loading branch information
andy-t-wang authored Oct 25, 2024
1 parent 4d2f5a0 commit ea7cd56
Showing 1 changed file with 20 additions and 5 deletions.
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
```

This will launch a demo mini app with all essential commands implemented, allowing you to explore and test the features.

0 comments on commit ea7cd56

Please sign in to comment.