add docs for health checks (#599)

2021-05-01 16:30:54 +01:00
parent 7f1af64527
commit 4b26e78109
2 changed files with 19 additions and 1 deletions
@@ -1,6 +1,8 @@
 # tonic-health

-A `tonic` based gRPC healthcheck implementation.
+A `tonic` based gRPC healthcheck implementation. It closely follows the official [health checking protocol](https://github.com/grpc/grpc/blob/master/doc/health-checking.md), although it may not implement all features described in the specs.
+
+Please follow the example in the [main repo](https://github.com/hyperium/tonic/tree/master/examples/src/health) to see how it works.

 ## Features