Skip to content

Commit

Permalink
Updated feedback from Lucie
Browse files Browse the repository at this point in the history
  • Loading branch information
anuptalwalkar committed Dec 1, 2016
1 parent b0cc763 commit 55639f5
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
10 changes: 5 additions & 5 deletions ulog/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Logging package

`package ulog` provides an API wrapper around the logging library [zap](https://github.com/uber-go/zap).
`ulog` uses the builder pattern to instantiate the logger. With `LogBuilder` you can perform pre-initialization setup
`package ulog` uses the builder pattern to instantiate the logger. With `LogBuilder` you can perform pre-initialization setup
by injecting configuration, custom logger, and log level prior to building the usable `ulog.Log` object. `ulog.Log`
interface provides a few benefits:
- Decouple services from the logger used underneath the framework.
- Easy to use API for logging.
- Easily swappable backend logger without changing the service.
- Decouple services from the logger used underneath the framework
- Easy to use API for logging
- Easily swappable backend logger without changing the service


## Sample usage
Expand All @@ -21,7 +21,7 @@ func main() {
logConfig := ulog.Configuration{}
logBuilder := ulog.Builder().WithConfiguration(&logConfig)

// build ulog.Log from logBuilder
// Build ulog.Log from logBuilder
log := lobBuilder.Build()

// Use logger in your service
Expand Down
10 changes: 5 additions & 5 deletions ulog/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@
// Package ulog is the Logging package.
//
// package ulog provides an API wrapper around the logging library zap (https://github.com/uber-go/zap).
// ulog uses the builder pattern to instantiate the logger. With LogBuilder you can perform pre-initialization setup
// package ulog uses the builder pattern to instantiate the logger. With LogBuilder you can perform pre-initialization setup
// by injecting configuration, custom logger, and log level prior to building the usable
// ulog.Log object. ulog.Loginterface provides a few benefits:
// - Decouple services from the logger used underneath the framework.
// - Easy to use API for logging.
// - Easily swappable backend logger without changing the service.
// - Decouple services from the logger used underneath the framework
// - Easy to use API for logging
// - Easily swappable backend logger without changing the service
//
//
// Sample usage
Expand All @@ -40,7 +40,7 @@
// logConfig := ulog.Configuration{}
// logBuilder := ulog.Builder().WithConfiguration(&logConfig)
//
// // build ulog.Log from logBuilder
// // Build ulog.Log from logBuilder
// log := lobBuilder.Build()
//
// // Use logger in your service
Expand Down

0 comments on commit 55639f5

Please sign in to comment.