Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
added sections Documentation/Philosophy/Features/Roadmap
  • Loading branch information
mcatanzariti authored Oct 26, 2022
1 parent 1f2df79 commit 943becd
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,29 @@
A Redis client for Rust inspired by [StackExchange.Redis](https://github.com/StackExchange/StackExchange.Redis)
& [redis-async-rs](https://github.com/benashford/redis-async-rs)
An asynchronous Redis client for Rust.

## Documentation
[Official Documentation](https://docs.rs/redis-driver/latest/redis_driver/)

## Philosophy
* Low allocations
* Full async library
* Rust idiomatic API

## Features
* Support all [Redis Commands](https://redis.io/commands/) (except Cluster related commands)
* Async support ([tokio](https://tokio.rs/) or [async-std](https://async.rs/))
* Different client types:
* Single client
* [Multiplexed](https://redis.com/blog/multiplexing-explained/) client
* Pooled client manager (with [bb8](https://docs.rs/bb8/latest/bb8/))
* Automatic command batching
* Configuration with Redis URL or dedicated builder
* [TLS](https://redis.io/docs/manual/security/encryption/) support
* [Transaction](https://redis.io/docs/manual/transactions/) support
* [Pub/sub](https://redis.io/docs/manual/pubsub/) support
* [Sentinel](https://redis.io/docs/manual/sentinel/) support
* [LUA Scripts/Functions](https://redis.io/docs/manual/programmability/) support

## Roadmap
* [Cluster](https://redis.io/docs/manual/scaling/) support
* [Pipelining](https://redis.io/docs/manual/pipelining/) support
* [RedisJSON](https://redis.io/docs/stack/json/) support

0 comments on commit 943becd

Please sign in to comment.