vendor/github.com/mattn/go-colorable/README.md

   1 # go-colorable
   2
   3 [![Godoc Reference](https://godoc.org/github.com/mattn/go-colorable?status.svg)](http://godoc.org/github.com/mattn/go-colorable)
   4 [![Build Status](https://travis-ci.org/mattn/go-colorable.svg?branch=master)](https://travis-ci.org/mattn/go-colorable)
   5 [![Coverage Status](https://coveralls.io/repos/github/mattn/go-colorable/badge.svg?branch=master)](https://coveralls.io/github/mattn/go-colorable?branch=master)
   6 [![Go Report Card](https://goreportcard.com/badge/mattn/go-colorable)](https://goreportcard.com/report/mattn/go-colorable)
   7
   8 Colorable writer for windows.
   9
  10 For example, most of logger packages doesn't show colors on windows. (I know we can do it with ansicon. But I don't want.)
  11 This 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
  25 logrus.SetFormatter(&logrus.TextFormatter{ForceColors: true})
  26 logrus.SetOutput(colorable.NewColorableStdout())
  27
  28 logrus.Info("succeeded")
  29 logrus.Warn("not correct")
  30 logrus.Error("something error")
  31 logrus.Fatal("panic")
  32 ```
  33
  34 You 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
  44 MIT
  45
  46 # Author
  47
  48 Yasuhiro Matsumoto (a.k.a mattn)