From 760dca9a088ec39c63d5080b781379fc992a1f73 Mon Sep 17 00:00:00 2001 From: M Alghazwi Date: Thu, 9 Jan 2025 10:37:06 +0100 Subject: [PATCH] add documentation and clean up --- README.md | 2 +- codex-plonky2-circuits/README.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2a37494..6b23404 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,6 @@ Repository organization Documentation ----------------- -To be added soon. +See the write-ups on [plonky2 storage proofs](https://hackmd.io/@NQdG6IOmQE6astjwhJ6ACw/rJSsScfAR) and [proof recursion](https://hackmd.io/@NQdG6IOmQE6astjwhJ6ACw/rk85D2HX1e) **WARNING**: This repository contains work-in-progress prototypes, and has not received careful code review. It is NOT ready for production use. diff --git a/codex-plonky2-circuits/README.md b/codex-plonky2-circuits/README.md index 56dff6a..7c6f9be 100644 --- a/codex-plonky2-circuits/README.md +++ b/codex-plonky2-circuits/README.md @@ -19,8 +19,8 @@ This crate is an implementation of the [codex storage proofs circuits](https://g - [`utils`](./src/circuits/utils.rs) contains helper functions. -## Documentation -writeup coming soon... +- [`recursion`](./src/recursion) contains various approaches of implementing recursion circuits for aggregating proofs. + ## Usage see [`workflow`](../workflow) for how to use the circuits and run them.