Skip to content

Commit

Permalink
chore: Update README (#227)
Browse files Browse the repository at this point in the history
  • Loading branch information
clabby authored Jun 10, 2024
1 parent bd94c29 commit 4d8360c
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ verify an [L2 output root][g-output-root] from the L1 inputs it was [derived fro

**`kona`**

- [`client`](./bin/client): The bare-metal program that runs on top of a [fault proof VM][g-fault-proof-vm].
- [`client`](./bin/programs/client): The bare-metal program that runs on top of a [fault proof VM][g-fault-proof-vm].
- [`host`](./bin/host): The host program that runs natively alongside the FPVM, serving as the [Preimage Oracle][g-preimage-oracle] server.

**Build Pipelines**
Expand All @@ -45,9 +45,12 @@ verify an [L2 output root][g-output-root] from the L1 inputs it was [derived fro
**`client` / `host` SDK**

- [`common`](./crates/common): A suite of utilities for developing `client` programs to be ran on top of Fault Proof VMs.
- [`common-proc`](./crates/common-proc): Proc macro for the `client` program entrypoint.
- [`primitives`](./crates/primitives): Primitive types for use in `kona` crates.
- [`preimage`](./crates/preimage): High level interfaces to the [`PreimageOracle`][fpp-specs] ABI
- [`mpt`](./crrates/mpt): Utilities for interacting with the Merkle Patricia Trie in the client program.
- [`derive`](./crates/derive): `no_std` compatible implementation of the [derivation pipeline][g-derivation-pipeline].
- [`plasma`](./crates/plasma/): Plasma extension to `kona-derive`

## Book

Expand Down

0 comments on commit 4d8360c

Please sign in to comment.