redigo/README.markdown

45 lines
1.5 KiB
Markdown
Raw Normal View History

2022-10-25 18:38:58 +03:00
Redigo
======
Redigo is a [Go](http://golang.org/) client for the [Redis](http://redis.io/) database.
Features
-------
2022-10-25 18:42:46 +03:00
* A [Print-like](http://godoc.org/git.bit5.ru/backend/redigo/redis#hdr-Executing_Commands) API with support for all Redis commands.
* [Pipelining](http://godoc.org/git.bit5.ru/backend/redigo/redis#hdr-Pipelining), including pipelined transactions.
* [Publish/Subscribe](http://godoc.org/git.bit5.ru/backend/redigo/redis#hdr-Publish_and_Subscribe).
* [Connection pooling](http://godoc.org/git.bit5.ru/backend/redigo/redis#Pool).
* [Script helper type](http://godoc.org/git.bit5.ru/backend/redigo/redis#Script) with optimistic use of EVALSHA.
* [Helper functions](http://godoc.org/git.bit5.ru/backend/redigo/redis#hdr-Reply_Helpers) for working with command replies.
2022-10-25 18:38:58 +03:00
Documentation
-------------
2022-10-25 18:42:46 +03:00
- [API Reference](http://godoc.org/git.bit5.ru/backend/redigo/redis)
- [FAQ](https://git.bit5.ru/backend/redigo/wiki/FAQ)
2022-10-25 18:38:58 +03:00
Installation
------------
Install Redigo using the "go get" command:
2022-10-25 18:42:46 +03:00
go get git.bit5.ru/backend/redigo/redis
2022-10-25 18:38:58 +03:00
The Go distribution is Redigo's only dependency.
Contributing
------------
Contributions are welcome.
Before writing code, send mail to gary@beagledreams.com to discuss what you
plan to do. This gives me a chance to validate the design, avoid duplication of
effort and ensure that the changes fit the goals of the project. Do not start
the discussion with a pull request.
License
-------
Redigo is available under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).