From 64851884600d777a6d7ff91f6c5783f7b76fe7bc Mon Sep 17 00:00:00 2001
From: Vladimir Mihailenco <vladimir.webdev@gmail.com>
Date: Sun, 29 Sep 2013 12:51:07 +0300
Subject: [PATCH] Add v2 readme.

---
 v2/README.md | 213 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 213 insertions(+)
 create mode 100644 v2/README.md

diff --git a/v2/README.md b/v2/README.md
new file mode 100644
index 0000000..2f51e3b
--- /dev/null
+++ b/v2/README.md
@@ -0,0 +1,213 @@
+Redis client for Golang
+=======================
+
+Supports:
+
+- Redis 2.6 commands except QUIT, MONITOR, SLOWLOG and SYNC.
+- Pub/sub.
+- Transactions.
+- Pipelining.
+- Connection pool.
+- TLS connections.
+- Thread safety.
+- Timeouts.
+
+API docs: http://godoc.org/github.com/vmihailenco/redis/v2
+
+Installation
+------------
+
+Install:
+
+    go get github.com/vmihailenco/redis/v2
+
+Getting started
+---------------
+
+Let's start with connecting to Redis using TCP:
+
+```go
+client := redis.NewTCPClient(&redis.Options{
+	Addr:     "localhost:6379",
+	Password: "", // no password set
+	DB:       0,  // use default DB
+})
+defer client.Close()
+
+ping := client.Ping()
+fmt.Println(ping.Val(), ping.Err())
+// Output: PONG <nil>
+```
+
+or using Unix socket:
+
+```go
+client := redis.NewUnixClient(&redis.Options{
+	Addr: "/tmp/redis.sock",
+})
+defer client.Close()
+
+ping := client.Ping()
+fmt.Println(ping.Val(), ping.Err())
+// Output: PONG <nil>
+```
+
+Then we can start sending commands:
+
+```go
+set := client.Set("foo", "bar")
+fmt.Println(set.Err(), set.Val())
+
+get := client.Get("foo")
+fmt.Println(get.Err(), get.Val())
+
+// Output: <nil> OK
+// <nil> bar
+```
+
+We can also pipeline two commands together:
+
+```go
+pipeline := client.Pipeline()
+set := pipeline.Set("key1", "hello1")
+get := pipeline.Get("key2")
+cmds, err := pipeline.Exec()
+fmt.Println(cmds, err)
+fmt.Println(set)
+fmt.Println(get)
+// Output: [SET key1 hello1: OK GET key2: (nil)] (nil)
+// SET key1 hello1: OK
+// GET key2: (nil)
+```
+
+or:
+
+```go
+client := redis.NewTCPClient(&redis.Options{
+	Addr: ":6379",
+})
+defer client.Close()
+
+cmds, err := client.Pipelined(func(c *redis.Pipeline) {
+	c.Set("key1", "hello1")
+	c.Get("key2")
+})
+fmt.Println(cmds, err)
+// Output: [SET key1 hello1: OK GET key2: (nil)] (nil)
+```
+
+We can also send several commands in transaction:
+
+```go
+incr := func(tx *redis.Multi) ([]redis.Cmder, error) {
+	get := tx.Get("key")
+	if err := get.Err(); err != nil && err != redis.Nil {
+		return nil, err
+	}
+
+	val, _ := strconv.ParseInt(get.Val(), 10, 64)
+
+	return tx.Exec(func() {
+		tx.Set("key", strconv.FormatInt(val+1, 10))
+	})
+}
+
+client := redis.NewTCPClient(&redis.Options{
+	Addr: ":6379",
+})
+defer client.Close()
+
+client.Del("key")
+
+tx := client.Multi()
+defer tx.Close()
+
+watch := tx.Watch("key")
+_ = watch.Err()
+
+for {
+	cmds, err := incr(tx)
+	if err == redis.TxFailedErr {
+		continue
+	} else if err != nil {
+		panic(err)
+	}
+	fmt.Println(cmds, err)
+	break
+}
+
+// Output: [SET key 1: OK] <nil>
+```
+
+To subscribe to the channel:
+
+```go
+pubsub := client.PubSub()
+defer pubsub.Close()
+
+err := pubsub.Subscribe("mychannel")
+_ = err
+
+msg, err := pubsub.Receive()
+fmt.Println(msg, err)
+
+pub := client.Publish("mychannel", "hello")
+_ = pub.Err()
+
+msg, err = pubsub.Receive()
+fmt.Println(msg, err)
+
+// Output: &{subscribe mychannel 1} <nil>
+// &{mychannel hello} <nil>
+```
+
+You can also write custom commands:
+
+```go
+Get := func(client *redis.Client, key string) *redis.StringCmd {
+	cmd := redis.NewStringCmd("GET", key)
+	client.Process(cmd)
+	return cmd
+}
+
+client := redis.NewTCPClient(&redis.Options{
+	Addr: ":6379",
+})
+defer client.Close()
+
+get := Get(client, "key_does_not_exist")
+fmt.Printf("%q %s", get.Val(), get.Err())
+// Output: "" (nil)
+```
+
+Look and feel
+-------------
+
+Some corner cases:
+
+    SORT list LIMIT 0 2 ASC
+    client.Sort("list", redis.Sort{Offset: 0, Count: 2, Order: "ASC"})
+
+    ZRANGEBYSCORE zset -inf +inf WITHSCORES LIMIT 0 2
+    client.ZRangeByScoreWithScores("zset", "-inf", "+inf", 0, 2)
+
+    ZINTERSTORE out 2 zset1 zset2 WEIGHTS 2 3 AGGREGATE SUM
+    client.ZInterStore("out", redis.ZStore{Weights: []int64{2, 3}}, "zset1", "zset2")
+
+    EVAL "return {KEYS[1],ARGV[1]}" 1 "key" "hello"
+    client.Eval("return {KEYS[1],ARGV[1]}", []string{"key"}, []string{"hello"})
+
+Contributing
+------------
+
+Configure Redis to allow maximum 10 clients:
+
+    maxclients 10
+
+Run tests:
+
+    go test -gocheck.v
+
+Run benchmarks:
+
+    go test -gocheck.b