Skip to content

Commit bc1f49c

Browse files
README
1 parent 00f0138 commit bc1f49c

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,33 @@
11
# 🧻 devslog - Go [slog.Handler](https://pkg.go.dev/log/slog#Handler) for development
2-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/golang-cz/devslog/blob/master/LICENSE)
3-
[![Go Report Card](https://goreportcard.com/badge/github.com/golang-cz/devslog)](https://goreportcard.com/report/github.com/golang-cz/devslog)
4-
[![Go Reference](https://pkg.go.dev/badge/github.com/golang-cz/devslog.svg)](https://pkg.go.dev/github.com/golang-cz/devslog)
2+
3+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/golang-cz/devslog/blob/master/LICENSE)
4+
[![Go Report Card](https://goreportcard.com/badge/github.com/golang-cz/devslog)](https://goreportcard.com/report/github.com/golang-cz/devslog)
5+
[![Go Reference](https://pkg.go.dev/badge/github.com/golang-cz/devslog.svg)](https://pkg.go.dev/github.com/golang-cz/devslog)
56

67
`devslog` is a zero dependency structured logging handler for Go's [`log/slog`](https://pkg.go.dev/log/slog) package with pretty and colorful output for developers.
78

89
### Devslog output
10+
911
![image](https://github.com/golang-cz/devslog/assets/17728576/cfdc1634-16fe-4dd0-a643-21bf519cd4fe)
1012

1113
#### Compared to
14+
1215
`TextHandler`
1316
![image](https://github.com/golang-cz/devslog/assets/17728576/49aab1c0-93ba-409d-8637-a96eeeaaf0e1)
1417

1518
`JSONHandler`
1619
![image](https://github.com/golang-cz/devslog/assets/17728576/775af693-2f96-47e8-9190-5ead77b41a27)
1720

1821
## Install
22+
1923
```
2024
go get github.com/golang-cz/devslog@latest
2125
```
2226

2327
## Examples
28+
2429
### Logger without options
30+
2531
```go
2632
logger := slog.New(devslog.NewHandler(os.Stdout, nil))
2733

@@ -30,6 +36,7 @@ slog.SetDefault(logger)
3036
```
3137

3238
### Logger with custom options
39+
3340
```go
3441
// new logger with options
3542
opts := &devslog.Options{
@@ -48,7 +55,9 @@ slog.SetDefault(logger)
4855
```
4956

5057
### Logger with default slog options
58+
5159
Handler accepts default [slog.HandlerOptions](https://pkg.go.dev/golang.org/x/exp/slog#HandlerOptions)
60+
5261
```go
5362
// slog.HandlerOptions
5463
slogOpts := &slog.HandlerOptions{
@@ -72,6 +81,7 @@ slog.SetDefault(logger)
7281
```
7382

7483
### Example usage
84+
7585
```go
7686
slogOpts := &slog.HandlerOptions{
7787
AddSource: true,
@@ -98,8 +108,9 @@ slog.SetDefault(logger)
98108
```
99109

100110
## Options
111+
101112
| Parameter | Description | Default | Value |
102-
|--------------------|----------------------------------------------------------------|----------------|----------------------|
113+
| ------------------ | -------------------------------------------------------------- | -------------- | -------------------- |
103114
| MaxSlicePrintSize | Specifies the maximum number of elements to print for a slice. | 50 | uint |
104115
| SortKeys | Determines if attributes should be sorted by keys. | false | bool |
105116
| TimeFormat | Time format for timestamp. | "[15:04:05]" | string |
@@ -111,3 +122,4 @@ slog.SetDefault(logger)
111122
| ErrorColor | Color for Error level | devslog.Red | devslog.Color (uint) |
112123
| MaxErrorStackTrace | Max stack trace frames for errors | 0 | uint |
113124
| StringerFormatter | Use Stringer interface for formatting | false | bool |
125+
| NoColor | Disable coloring | false | bool |

0 commit comments

Comments
 (0)