aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTrey Bastian <trey.bastian@gmail.com>2015-05-17 02:23:54 +0100
committerTrey Bastian <trey.bastian@gmail.com>2015-05-17 02:23:54 +0100
commit11c9eb3f43312d0009dd4856a197c012608901b9 (patch)
tree4265b5cc99cb69664534bfe1b9cdcdaee4a7c164 /README.md
parentdce193934a2949967d8af4b2104e90c9fa82f5eb (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 12 insertions, 6 deletions
diff --git a/README.md b/README.md
index a116820..8879dea 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,13 @@
# 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) [![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?branch=master)](https://coveralls.io/r/TreyBastian/colourize?branch=master)
+An ANSI colour terminal package for Go.
+Supports all ANSI colours and emphasis. Not compatible with Windows systems.
+
+# Installation
+
+ go get github.com/TreyBastian/colourize
+
# Usage
package main
@@ -12,9 +17,10 @@ An ANSI colour terminal package for Go
)
func main() {
- fmt.Println(colourize("Hello World!", Green, Whitebg, Bold)
+ fmt.Println(c.colourize("Hello World!", c.Green, c.Whitebg, c.Bold)
}
-
-Supports all ANSI colours and emphasis. Not compatible with Windows systems.
-I'm not expecting anyone to actually use this package or even find it, but if you do end up using it drop me a line and let me know!
+
+# Projects Using colourize
+
+Nothing Yet, but if you use it let me know!