diff --git a/README.md b/README.md index e69de29..f2c1c87 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,33 @@ +# gRPC + +A utility lib, implementing some of the go-micro patterns with gRPC. + +Features: +- [x] simple configuration with options +- [x] embeded gorm database with options (branch db) +- [x] simple TLS configuration +- [ ] TLS auth +- [ ] client connection pool +- [ ] registry / resolver resolution + - [ ] mdns + - [ ] kubernetes +- [ ] default interceptors implementation: + - [ ] validation + - [ ] health + - [ ] context logger + - [ ] sentry + - [ ] rate-limiting + - [ ] auth claim in context + - [ ] recovery + - [ ] tracing (open-tracing) + - [ ] metrics (prometheus) + - [ ] retries + - [ ] context DB / transaction + - ... +- [ ] api gateway with middleware: + - [ ] auth + - [ ] cors + - [ ] logging + - [ ] tracing + - [ ] metrics +- [ ] broker, based on nats-streaming \ No newline at end of file