aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/mattn/go-colorable/README.md
diff options
context:
space:
mode:
authorMichael Muré <batolettre@gmail.com>2018-07-17 20:23:14 +0200
committerMichael Muré <batolettre@gmail.com>2018-07-17 20:23:14 +0200
commit1332a6ec0a00b2475bc2b7b35b4c61425361d6b6 (patch)
treeff9ee93ea4a3bafc99d049d4f0c7b9f199ff0fec /vendor/github.com/mattn/go-colorable/README.md
parent9e6c687fca71103fd7550e25c471b9f805337b09 (diff)
downloadgit-bug-1332a6ec0a00b2475bc2b7b35b4c61425361d6b6.tar.gz
ls: add some colors
Diffstat (limited to 'vendor/github.com/mattn/go-colorable/README.md')
-rw-r--r--vendor/github.com/mattn/go-colorable/README.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/vendor/github.com/mattn/go-colorable/README.md b/vendor/github.com/mattn/go-colorable/README.md
new file mode 100644
index 00000000..56729a92
--- /dev/null
+++ b/vendor/github.com/mattn/go-colorable/README.md
@@ -0,0 +1,48 @@
+# go-colorable
+
+[![Godoc Reference](https://godoc.org/github.com/mattn/go-colorable?status.svg)](http://godoc.org/github.com/mattn/go-colorable)
+[![Build Status](https://travis-ci.org/mattn/go-colorable.svg?branch=master)](https://travis-ci.org/mattn/go-colorable)
+[![Coverage Status](https://coveralls.io/repos/github/mattn/go-colorable/badge.svg?branch=master)](https://coveralls.io/github/mattn/go-colorable?branch=master)
+[![Go Report Card](https://goreportcard.com/badge/mattn/go-colorable)](https://goreportcard.com/report/mattn/go-colorable)
+
+Colorable writer for windows.
+
+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.)
+This package is possible to handle escape sequence for ansi color on windows.
+
+## Too Bad!
+
+![](https://raw.githubusercontent.com/mattn/go-colorable/gh-pages/bad.png)
+
+
+## So Good!
+
+![](https://raw.githubusercontent.com/mattn/go-colorable/gh-pages/good.png)
+
+## Usage
+
+```go
+logrus.SetFormatter(&logrus.TextFormatter{ForceColors: true})
+logrus.SetOutput(colorable.NewColorableStdout())
+
+logrus.Info("succeeded")
+logrus.Warn("not correct")
+logrus.Error("something error")
+logrus.Fatal("panic")
+```
+
+You can compile above code on non-windows OSs.
+
+## Installation
+
+```
+$ go get github.com/mattn/go-colorable
+```
+
+# License
+
+MIT
+
+# Author
+
+Yasuhiro Matsumoto (a.k.a mattn)