README.markdown

Documentation: github.com/gomodule/redigo

     1Redigo
     2======
     3
     4[![Build Status](https://travis-ci.org/gomodule/redigo.svg?branch=master)](https://travis-ci.org/gomodule/redigo)
     5[![GoDoc](https://godoc.org/github.com/gomodule/redigo/redis?status.svg)](https://godoc.org/github.com/gomodule/redigo/redis)
     6
     7Redigo is a [Go](http://golang.org/) client for the [Redis](http://redis.io/) database.
     8
     9Features
    10-------
    11
    12* A [Print-like](http://godoc.org/github.com/gomodule/redigo/redis#hdr-Executing_Commands) API with support for all Redis commands.
    13* [Pipelining](http://godoc.org/github.com/gomodule/redigo/redis#hdr-Pipelining), including pipelined transactions.
    14* [Publish/Subscribe](http://godoc.org/github.com/gomodule/redigo/redis#hdr-Publish_and_Subscribe).
    15* [Connection pooling](http://godoc.org/github.com/gomodule/redigo/redis#Pool).
    16* [Script helper type](http://godoc.org/github.com/gomodule/redigo/redis#Script) with optimistic use of EVALSHA.
    17* [Helper functions](http://godoc.org/github.com/gomodule/redigo/redis#hdr-Reply_Helpers) for working with command replies.
    18
    19Documentation
    20-------------
    21
    22- [API Reference](http://godoc.org/github.com/gomodule/redigo/redis)
    23- [FAQ](https://github.com/gomodule/redigo/wiki/FAQ)
    24- [Examples](https://godoc.org/github.com/gomodule/redigo/redis#pkg-examples)
    25
    26Installation
    27------------
    28
    29Install Redigo using the "go get" command:
    30
    31    go get github.com/gomodule/redigo/redis
    32
    33The Go distribution is Redigo's only dependency.
    34
    35Related Projects
    36----------------
    37
    38- [rafaeljusto/redigomock](https://godoc.org/github.com/rafaeljusto/redigomock) - A mock library for Redigo.
    39- [chasex/redis-go-cluster](https://github.com/chasex/redis-go-cluster) - A Redis cluster client implementation.
    40- [FZambia/go-sentinel](https://github.com/FZambia/go-sentinel) - Redis Sentinel support for Redigo
    41- [PuerkitoBio/redisc](https://github.com/PuerkitoBio/redisc) - Redis Cluster client built on top of Redigo
    42
    43Contributing
    44------------
    45
    46See [CONTRIBUTING.md](https://github.com/gomodule/redigo/blob/master/.github/CONTRIBUTING.md).
    47
    48License
    49-------
    50
    51Redigo is available under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).
View as plain text