vendor/github.com/mitchellh/colorstring/README.md

   1 # colorstring [![Build Status](https://travis-ci.org/mitchellh/colorstring.svg)](https://travis-ci.org/mitchellh/colorstring)
   2
   3 colorstring is a [Go](http://www.golang.org) library for outputting colored
   4 strings to a console using a simple inline syntax in your string to specify
   5 the color to print as.
   6
   7 For example, the string `[blue]hello [red]world` would output the text
   8 "hello world" in two colors. The API of colorstring allows for easily disabling
   9 colors, adding aliases, etc.
  10
  11 ## Installation
  12
  13 Standard `go get`:
  14
  15 ```
  16 $ go get github.com/mitchellh/colorstring
  17 ```
  18
  19 ## Usage & Example
  20
  21 For usage and examples see the [Godoc](http://godoc.org/github.com/mitchellh/colorstring).
  22
  23 Usage is easy enough:
  24
  25 ```go
  26 colorstring.Println("[blue]Hello [red]World!")
  27 ```
  28
  29 Additionally, the `Colorize` struct can be used to set options such as
  30 custom colors, color disabling, etc.