Skip to content

Commit

Permalink
Improve documentation a little
Browse files Browse the repository at this point in the history
  • Loading branch information
Jille committed Sep 9, 2020
1 parent f4d0b09 commit 7d7e9b3
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

[![Godoc](https://godoc.org/github.com/Jille/raft-grpc-leader-rpc/leaderhealth?status.svg)](https://godoc.org/github.com/Jille/raft-grpc-leader-rpc/leaderhealth)

This small library allows you to send RPCs to your Raft leader.
Send gRPCs to your [Raft](https://github.com/hashicorp/raft) leader.

It connects to all your Raft nodes and uses [client-side health checks](https://github.com/grpc/proposal/blob/master/A17-client-side-health-checking.md) to only send RPCs to the master.

During leader elections you'll see about one RTT of errors, make sure your client can handle those and retries them.
During leader elections you'll see errors, make sure your client can handle those and retries them.

## Server side

Expand Down

0 comments on commit 7d7e9b3

Please sign in to comment.