aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFatih Arslan <ftharsln@gmail.com>2014-02-17 09:47:15 +0000
committerFatih Arslan <ftharsln@gmail.com>2014-02-17 09:47:15 +0000
commit823f4ed20f31e9aebfc545e1f4e2be6677686c44 (patch)
tree8ca600a8d5a5df2c27fe13a2d16819b3808a6802 /README.md
parent8653b308b11ed63b5a823f8cd06878d308a16dff (diff)
downloadcolour-823f4ed20f31e9aebfc545e1f4e2be6677686c44.tar.gz
colour-823f4ed20f31e9aebfc545e1f4e2be6677686c44.tar.bz2
Updates and cosmetic changes.
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 11 insertions, 12 deletions
diff --git a/README.md b/README.md
index a2d7809..d5ab69c 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@ go get github.com/fatih/color
## Examples
-# Standard colors
+### Standard colors
```go
// Print with default foreground colors
@@ -25,34 +25,33 @@ color.Green.Add(color.Bold).Println("Green with bold")
color.Red.Add(color.BgWhite, color.Underline).Printf("Red with Black background and underscore: %s\n", "format too!")
```
-# Custom colors
+### Custom colors
```go
// Create and reuse color objects
c := color.Cyan.Add(color.Underline)
-c.Println("Prints bold cyan.")
+c.Println("Prints cyan text with an underline.")
c.Printf("Thir prints bold cyan %s\n", "too!.")
-
// Create custom color objects:
-c := color.New(color.FgGreen, color.BgCyan, color.Italic)
-c.Print("Italic green with cyan backround")
+d := color.New(color.FgWhite, color.BgGreen)
+d.Println("White with green backround")
```
-# Plug into your existing code
+### Plug into your existing code
```go
// Use handy standard colors.
-color.Yello.Set()
-fmt.Println("Existing text in your codebase will be now in Cyan")
+color.Yellow.Set()
+fmt.Println("Existing text in your codebase will be now in Yellow")
fmt.Printf("This one %s\n", "too")
color.Unset() // don't forget to unset
-// You can use set custom objects too
-color.New(color.FgBlack, color.BgWhite, color.Bold).Set()
+// You can set custom objects too
+color.New(color.FgMagenta, color.Bold).Set()
defer color.Unset() // use it in your function
-fmt.Println("All text will be now bold red with white background.")
+fmt.Println("All text will be now bold magenta.")
```
## Credits