Skip to content

Commit

Permalink
README updates (#758)
Browse files Browse the repository at this point in the history
  • Loading branch information
rkuris authored Dec 3, 2024
1 parent 08d4833 commit 60291db
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down Expand Up @@ -103,7 +105,7 @@ Firewood comes with a CLI tool called `fwdctl` that enables one to create and in

## Test

```
```sh
cargo test --release
```

Expand Down

0 comments on commit 60291db

Please sign in to comment.