Skip to content

Latest commit

 

History

History
88 lines (56 loc) · 3.41 KB

README.md

File metadata and controls

88 lines (56 loc) · 3.41 KB
Raw

World Documentation

This repository contains the technical documentation for the World SDK and the World ID Protocol.

World ID

About World ID

World ID is the privacy-first identity protocol that brings global proof of personhood to the internet. More on World ID in the announcement blog post.

World ID lets you seamlessly integrate authentication into your app that verifies accounts belong to real persons through Sign in with World ID. For additional flexibility and cases where you need extreme privacy, Incognito Actions lets you verify users in a way that cannot be tracked across verifications.

Follow the Quick Start guide for the easiest way to get started.

Mini Apps

Mini apps enable third-party developers to create native-like applications within World App. We currently support World ID, Payments, and Sign in with Ethereum. Building a mini app will provide access to our rapidly growing user network and monetization opportunities via WLD and USDC.

How it Works

Mini Apps work by sending Commands via the MiniKit SDK to World App, and listening for Responses passed back.

To make it easy to build mini apps, we have released the MiniKit-JS SDK.

World Chain

World Chain is a blockchain for humans. World chain offers several unique primitives:

  • Free gas fees for all verified humans
  • Native mobile distribution to all World App users through mini-apps
  • Simplified crypto transactions through mini apps
  • Sybil resistance for developers via World ID
  • Airdrop of WLD tokens to all verified humans

These primitives enable World Chain builders to build never before possible applications and reach a global audience.

World Chain is built on the Superchain.

📄 Documentation

All the technical docs for the World SDK, World ID Protocol, World Chain, Mini Apps and their examples, guides can be found at https://docs.world.org/.

🧑‍💻 Developing locally

To develop locally and contribute to these docs, you can follow these steps after cloning the repo.

  • Activate required Node version (LTS 18)
nvm use
  • Install dependencies
pnpm install
  • Run locally
pnpm dev
  • Open browser at http://localhost:3000
  • To build the production bundle you can simply run.
pnpm build

✨ Contributors

Thanks to all the contributors who have made the World SDK possible!

Powered by