aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/README.md b/README.md
index 106a2e4..20c332a 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,18 @@
# colourize
An ANSI colour terminal package for Go
-[![GoDoc](https://godoc.org/github.com/TreyBastian/colourize?status.svg)](https://godoc.org/github.com/TreyBastian/colourize)
+[![GoDoc](https://godoc.org/github.com/TreyBastian/colourize?status.svg)](https://godoc.org/github.com/TreyBastian/colourize) [![Build Status](https://travis-ci.org/TreyBastian/colourize.svg?branch=master)](https://travis-ci.org/TreyBastian/colourize) [![Coverage Status](https://coveralls.io/repos/TreyBastian/colourize/badge.svg)](https://coveralls.io/r/TreyBastian/colourize)
+
+# Usage
+
+ package main
+ import (
+ c "github.com/TreyBastian/colourize"
+ "fmt"
+ )
+
+ func main() {
+ fmt.Println(colourize("Hello World!", Green, Whitebg, Bold)
+ }
+
+Supports all ANSI colours and emphasis. Not compatible with Windows systems.