From 60291dbd423645f83b845bc194bfddcb9708ee5b Mon Sep 17 00:00:00 2001 From: Ron Kuris Date: Tue, 3 Dec 2024 12:18:17 -0800 Subject: [PATCH] README updates (#758) --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a2e9bd23..6d34bb46 100644 --- a/README.md +++ b/README.md @@ -63,18 +63,20 @@ Firewood guarantees recoverability by not referencing the new nodes in a new rev `Revision`. ## Roadmap - - [ ] Complete the proof code - - [ ] Complete the revision manager - - [ ] Complete the API implementation - - [ ] Implement a node cache - - [ ] Hook up the RPC + +- [X] Complete the revision manager +- [X] Complete the API implementation +- [X] Implement a node cache +- [ ] Complete the proof code +- [ ] Hook up the RPC ## Build In order to build firewood, `protoc` must be installed. See instructions for installation [here](https://grpc.io/docs/protoc-installation/). On Mac, you can install via brew: -``` + +```sh brew install protobuf ``` @@ -103,7 +105,7 @@ Firewood comes with a CLI tool called `fwdctl` that enables one to create and in ## Test -``` +```sh cargo test --release ```