From 6a13bda650cd640a4649e427071c60a203866fe3 Mon Sep 17 00:00:00 2001
From: Tevin Zhang <mail2tevin@gmail.com>
Date: Wed, 25 May 2016 11:49:42 +0800
Subject: [PATCH] Refine usage in README

---
 README.md | 36 +++++++++++++++++++++++-------------
 1 file changed, 23 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index c1e199a..d2a640e 100644
--- a/README.md
+++ b/README.md
@@ -1,29 +1,39 @@
 # ABool
 :bulb: Atomic boolean library for Golang, optimized for performance yet simple to use.
 
+## Usage
+
+```go
+import "github.com/tevino/abool"
+
+cond := abool.New()  // default to false
+
+cond.Set()           // set to true
+cond.IsSet()         // returns true
+cond.UnSet()         // set to false
+cond.SetTo(true)     // set to whatever you want
+
+
+// embedding
+type Foo struct {
+    cond *abool.AtomicBool  // always use pointer to avoid copy
+}
+```
+
 ## Benchmark:
 
 - Golang 1.6.2
 - OS X 10.11.4
 
-```
+```shell
 # Read
 BenchmarkMutexRead-4       	100000000	        21.1 ns/op
 BenchmarkAtomicValueRead-4 	200000000	         6.33 ns/op
-BenchmarkAtomicBoolRead-4  	300000000	         4.28 ns/op
+BenchmarkAtomicBoolRead-4  	300000000	         4.28 ns/op  # <--- This package
 
 # Write
 BenchmarkMutexWrite-4      	100000000	        21.7 ns/op
-BenchmarkAtomicValueWrite-4	30000000	        47.8 ns/op
-BenchmarkAtomicBoolWrite-4 	200000000	         9.83 ns/op
+BenchmarkAtomicValueWrite-4	 30000000	        47.8 ns/op
+BenchmarkAtomicBoolWrite-4 	200000000	         9.83 ns/op  # <--- This package
 ```
 
-## Usage
-
-```
-var v AtomicBool
-v.Set() // set to true
-v.IsSet()  // returns true
-v.UnSet()  // set to false
-v.SetTo(true)  // set with gieven boolean
-```