Skip to content

Commit

Permalink
Linking to rust docs in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
andreev-io committed Aug 19, 2021
1 parent ce8e295 commit 23079a6
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@
The lightest distributed consensus library. Run your own replicated state machine! :heart:

## Using
To use this library, you only need to do three things.
First, import the crate. In your `Cargo.toml`, add
```
[dependencies]
little_raft = "0.1"
```

Then, to start running Little Raft, you only need to do three things.
1. Implement the StateMachine that you want your cluster to maintain. Little Raft will take care of replicating this machine across the cluster and achieving consensus on its state.
```rust
/// StateMachine describes a user-defined state machine that is replicated
Expand Down Expand Up @@ -122,7 +127,7 @@ where
```


With that, you're good to go. We are working on examples, but for now you can look at the `little_raft/tests` directory. We're working on adding more tests.
With that, you're good to go. We are working on examples, but for now you can look at the `little_raft/tests` directory and at the documentation at [https://docs.rs/little_raft/0.1.2/little_raft/](https://docs.rs/little_raft/0.1.2/little_raft/). We're working on adding more tests.


## Testing
Expand Down

0 comments on commit 23079a6

Please sign in to comment.