Skip to content

Developer documentation for the Worldcoin SDK and World ID.

License

Notifications You must be signed in to change notification settings

0xmatt11/world-id-docs

 
 

Repository files navigation

Worldcoin Documentation

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

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.

📄 Documentation

All the technical docs for the Wordcoin SDK, World ID Protocol, examples, guides can be found at https://docs.worldcoin.org/

🧑‍💻 Developing locally

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

  • Activate required Node version (18.x)

    nvm use 18 # only if you are using nvm
    
  • Install dependencies

    pnpm install
  • Run locally

    pnpm start
  • 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 Worldcoin SDK possible!

Powered by

About

Developer documentation for the Worldcoin SDK and World ID.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • MDX 60.3%
  • TypeScript 34.2%
  • JavaScript 4.1%
  • CSS 1.4%