Update docs.

doc.go

@@ -0,0 +1,123 @@
+// Copyright 2012 The Redis Client Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+/*
+Package github.com/vmihailenco/redis implements a Redis client.
+
+Let's start with connecting to Redis:
+
+    password := "" // no password set
+    db := -1 // use default DB
+    client := redis.NewTCPClient("localhost:6379", password, db)
+    defer client.Close()
+
+Then we can start sending commands:
+
+    if err := client.Set("foo", "bar"); err != nil { panic(err) }
+
+    get := client.Get("foo")
+    if err := get.Err(); err != nil { panic(err) }
+    fmt.Println(get.Val())
+
+We can also pipeline two commands together:
+
+    var set *redis.StatusReq
+    var get *redis.StringReq
+    reqs, err := client.Pipelined(func(c *redis.PipelineClient)) {
+        set = c.Set("key1", "hello1")
+        get = c.Get("key2")
+    }
+    if err != nil { panic(err) }
+    if err := set.Err(); err != nil { panic(err) }
+    if err := get.Err(); err != nil { panic(err) }
+    fmt.Println(get.Val())
+    fmt.Println(reqs[0] == set)
+    fmt.Println(reqs[1] == get)
+
+or:
+
+    pipeline, err := client.PipelineClient()
+    if err != nil {
+        panic(err)
+    }
+    defer pipeline.Close()
+
+    set := pipeline.Set("key1", "hello1")
+    get := pipline.Get("key2")
+
+    reqs, err := pipeline.RunQueued()
+    if err != nil { panic(err) }
+
+    if err := set.Err(); err != nil { panic(err) }
+    if err := get.Err(); err != nil { panic(err) }
+    fmt.Println(get.Val())
+    fmt.Println(reqs[0] == set)
+    fmt.Println(reqs[1] == get)
+
+We can also send several commands in transaction:
+
+    func incrKeyInTransaction(multi *redis.MultiClient) ([]redis.Req, error) {
+        get := multi.Get("key")
+        if err := get.Err(); err != nil {
+            panic(err)
+        }
+
+        val, err := strconv.ParseInt(get.Val(), 10, 64)
+        if err != nil { panic(err) }
+
+        reqs, err = multi.Exec(func() {
+            multi.Set("key", val + 1)
+        })
+        // Transaction failed. Repeat.
+        if err == redis.Nil {
+            return incrKeyInTransaction(multi)
+        }
+        return reqs, err
+    }
+
+    multi, err := client.MultiClient()
+    if err != nil { panic(err) }
+    defer multi.Close()
+
+    watch := multi.Watch("key")
+    if err := watch.Err(); err != nil { panic(err) }
+
+    reqs, err := incrKeyInTransaction(multi)
+    if err != nil { panic(err) }
+    for _, req := range reqs {
+        // ...
+    }
+
+To subscribe to the channel:
+
+    pubsub, err := client.PubSubClient()
+    if err != nil { panic(err) }
+    defer pubsub.Close()
+
+    ch, err := pubsub.Subscribe("mychannel")
+    if err != nil { panic(err) }
+
+    go func() {
+        for msg := range ch {
+            if err := msg.Err; err != nil { panic(err) }
+            message := msg.Message
+        }
+    }
+
+You can also write custom commands:
+
+    func Get(client *redis.Client, key string) *redis.StringReq {
+        req := redis.NewStringReq("GET", key)
+        client.Process(req)
+        return req
+    }
+
+    get := Get(redisClient, "key")
+    if err := get.Err(); err != nil && err != redis.Nil { panic(err) }
+
+Client uses connection pool to send commands. You can change maximum number of connections with:
+
+    client.ConnPool.(*redis.MultiConnPool).MaxCap = 1
+*/
+package redis