Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
Updated README with a synopsis, code syntax hightlighting and license
section.
  • Loading branch information
philip-bui committed Mar 16, 2019
1 parent eae4737 commit 99b0f28
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,15 @@
[GoDoc]: https://godoc.org/github.com/philip-bui/grpc-zerolog
[GoDoc Widget]: https://godoc.org/github.com/philip-bui/grpc-zerolog?status.svg

```
Implementation of gRPC Logging Middleware, integrating [Zerolog](https://github.com/rs/zerolog) as a gRPC [Interceptor](https://github.com/grpc-ecosystem/go-grpc-middleware) to log the following fields:

- Request Protobufs as JSON.
- Response Protobufs as JSON, or Errors.
- Status Code, Duration, Timestamp, Service Name, Service Method, IP, Metadata Fields and User Agent.

## Usage

```go
import (
"github.com/philip-bui/grpc-zerolog"
)
Expand All @@ -29,4 +37,6 @@ func main() {
}
```

## License

gRPC Zerolog is available under the MIT license. [See LICENSE](https://github.com/philip-bui/grpc-zerolog/blob/master/LICENSE) for details.

0 comments on commit 99b0f28

Please sign in to comment.