Skip to content

Commit

Permalink
Update README.md (#479)
Browse files Browse the repository at this point in the history
  • Loading branch information
brunny-eth authored Feb 17, 2025
1 parent f67a7f1 commit aa8931e
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,16 @@
[![web-prover workflow](https://github.com/pluto/web-prover/actions/workflows/web-prover.yaml/badge.svg)](https://github.com/pluto/web-prover/actions/workflows/web-prover.yaml)
[![docs](https://img.shields.io/badge/docs-e28f00)](https://docs.pluto.xyz)

Pluto's Web Prover repo contains the source code for three types of [Web Proofs](https://pluto.xyz/blog/introducing-pluto#1927a922ef2980748958f9f1fa514320):
The Web Prover is infrastructure for generating Web Proofs. There are 3 components of the Web Prover — (1) the Client Crates, which run inside of the app or browser; (2) Notary Crate, which is a hosted service; and (3) the Proofs Crate, which handles running the circuits through the `client-side-prover`.

The default option for generating Web Proofs is to use the Pluto-hosted service. We recommend using the Javascript SDK, which uses a Pluto-hosted notary. Learn more [here](https://docs.pluto.xyz/guides/using-the-javascript-sdk). Developers do not need to set up the prover or host it themselves, unless they explicitly want to self-host this infrastructure or build custom infrastructure.

Pluto's Web Prover repo contains the source code for the three types of Web Proofs:
- [Origo proofs](https://pluto.xyz/blog/web-proof-techniques-origo-mode),
- [Trusted Execution Environment (TEE) proofs](https://pluto.xyz/blog/web-proof-techniques-tee-mode) and
- [MPC proofs](https://pluto.xyz/blog/web-proof-techniques-mpc-mode) via TLSNotary


## How to get started

Visit the [Pluto documentation](https://docs.pluto.xyz) for integration guides, conceptual overviews, and reference materials.
Expand Down

0 comments on commit aa8931e

Please sign in to comment.