Skip to content

Commit dac97ef

Browse files
authored
Update README (#21)
1 parent 5b34ac9 commit dac97ef

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,33 @@
22

33
this repo contains a couple possible integrations with go.uber.org/zap
44

5-
65
## log
76

8-
The `log` package allows you to call the same `funcs` as with `zap`, but those will now also log on opentracing if you give a `context` or `span` as parameter.
7+
The `log` package allows you to call the same `funcs` as with `zap`, but those will now also log on opentracing if you
8+
give a `context` or `span` as parameter.
99

10-
### Example Usages:
10+
### Example Usages
1111

1212
Import the package and use it as your `log` package:
13-
```
14-
import "github.com/opentracing-contrib/go-zap/log"
13+
14+
```go
15+
import "github.com/opentracing-contrib/go-zap/log"
1516
```
1617

17-
Example with Debug level (similar funcs exist for the other levels).
18-
Log on zap only:
18+
Example with Debug level (similar funcs exist for the other levels). Log on zap only:
1919

20-
```
20+
```go
2121
func Debug(log string, fields ...zapcore.Field)
2222
```
2323

2424
Log on Zap and on Opentracing. The span is given directly or is retrieved from the context:
2525

26-
```
26+
```go
2727
func DebugWithSpan(span opentracing.Span, log string, fields ...zapcore.Field)
2828
func DebugWithContext(ctx context.Context, log string, fields ...zapcore.Field)
2929
```
3030

31-
3231
## utils
3332

34-
The `utils` package provides a function to translate a `zap` field into a standard `opentracing` field. Those two are almost similar (in implementation and concept)
33+
The `utils` package provides a function to translate a `zap` field into a standard `opentracing` field. Those two are
34+
almost similar (in implementation and concept)

0 commit comments

Comments
 (0)