Skip to content

Commit

Permalink
better readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mimoo committed Jan 19, 2024
1 parent b5ff6db commit 936864c
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ cargo install --git https://github.com/sigma0-xyz/zkbitcoin.git

## Usage

There are two types of zkapps: [stateless](#stateless-zkapps) and [stateful](#stateful-zkapps).

### Stateless zkapps

A stateless zkapp is single-use, and the bitcoin it locks can be redeemed by anyone who can provide a proof of correct execution. An example of a stateless zkapp is in [`examples/circuit/stateless.circom`](examples/circuit/stateless.circom) (which releases funds to anyone who can find the preimage of a hash function).
Expand Down

0 comments on commit 936864c

Please sign in to comment.