diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index add88bd9e..22c4e86b5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -40,7 +40,7 @@ The following code guidelines will help make code review smoother. Use `unwrap` only in either of three circumstances: -1. Based on manual static anaylsis, you've concluded that it's impossible for +1. Based on manual static analysis, you've concluded that it's impossible for the code to panic; so unwrapping is *safe*. An example would be: let list = vec![a, b, c]; diff --git a/HACKING.md b/HACKING.md index 01862477f..d50904db6 100644 --- a/HACKING.md +++ b/HACKING.md @@ -22,7 +22,7 @@ The repository is structured in *crates*, as follows: * `radicle-cli-test`: The Radicle CLI testing framework, for writing documentation tests. * `radicle-cob`: Radicle Collaborative Objects (COBs). Provides a way of creating and traversing edit histories. * `radicle-crdt`: Conflict-free replicated datatypes (CRDTs) used for things like discussions and patches. -* `radicle-crypto`: A wrapper around Ed25519 cryptographic signing primitives . +* `radicle-crypto`: A wrapper around Ed25519 cryptographic signing primitives. * `radicle-dag`: A simple directed acyclic graph implementation used by `radicle-cob`. * `radicle-httpd`: The radicle HTTP daemon that serves API clients and Git fetch requests. * `radicle-node`: The radicle peer-to-peer daemon that enables users to connect to the network and share code. diff --git a/README.md b/README.md index 91b304791..500b5336e 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Heartwood is the third iteration of the Radicle Protocol, a powerful peer-to-peer code collaboration and publishing stack. The repository contains a -full implemention of Heartwood, complete with a user-friendly command-line +full implementation of Heartwood, complete with a user-friendly command-line interface (`rad`) and network daemon (`radicle-node`). Radicle was designed to be a secure, decentralized and powerful alternative to