README.md

Documentation: github.com/mattn/go-colorable

     1# go-colorable
     2
     3[![Build Status](https://github.com/mattn/go-colorable/workflows/test/badge.svg)](https://github.com/mattn/go-colorable/actions?query=workflow%3Atest)
     4[![Codecov](https://codecov.io/gh/mattn/go-colorable/branch/master/graph/badge.svg)](https://codecov.io/gh/mattn/go-colorable)
     5[![GoDoc](https://godoc.org/github.com/mattn/go-colorable?status.svg)](http://godoc.org/github.com/mattn/go-colorable)
     6[![Go Report Card](https://goreportcard.com/badge/mattn/go-colorable)](https://goreportcard.com/report/mattn/go-colorable)
     7
     8Colorable writer for windows.
     9
    10For example, most of logger packages doesn't show colors on windows. (I know we can do it with ansicon. But I don't want.)
    11This package is possible to handle escape sequence for ansi color on windows.
    12
    13## Too Bad!
    14
    15![](https://raw.githubusercontent.com/mattn/go-colorable/gh-pages/bad.png)
    16
    17
    18## So Good!
    19
    20![](https://raw.githubusercontent.com/mattn/go-colorable/gh-pages/good.png)
    21
    22## Usage
    23
    24```go
    25logrus.SetFormatter(&logrus.TextFormatter{ForceColors: true})
    26logrus.SetOutput(colorable.NewColorableStdout())
    27
    28logrus.Info("succeeded")
    29logrus.Warn("not correct")
    30logrus.Error("something error")
    31logrus.Fatal("panic")
    32```
    33
    34You can compile above code on non-windows OSs.
    35
    36## Installation
    37
    38```
    39$ go get github.com/mattn/go-colorable
    40```
    41
    42# License
    43
    44MIT
    45
    46# Author
    47
    48Yasuhiro Matsumoto (a.k.a mattn)
View as plain text