Skip to content

Commit

Permalink
Release v2.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
cabol committed May 21, 2023
1 parent 24663c0 commit ec641ba
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 8 deletions.
41 changes: 41 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,47 @@ All notable changes to this project will be documented in this file.

This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [v2.3.0](https://github.com/cabol/nebulex_redis_adapter/tree/v2.3.0) (2023-05-20)

[Full Changelog](https://github.com/cabol/nebulex_redis_adapter/compare/v2.2.0...v2.3.0)

**Implemented enhancements:**

- Allow passing Redis client options to `command` and `pipeline` functions
[#51](https://github.com/cabol/nebulex_redis_adapter/issues/51)
- New Redis Cluster management strategy
[#49](https://github.com/cabol/nebulex_redis_adapter/issues/49)
- Improve configuration for Redis Cluster mode
[#47](https://github.com/cabol/nebulex_redis_adapter/issues/47)

**Closed issues:**

- Refactoring `Codec` to `Serializer`
[#48](https://github.com/cabol/nebulex_redis_adapter/issues/48)
- Configurable codec to encode/decode Redis keys and values
[#45](https://github.com/cabol/nebulex_redis_adapter/issues/45)
- Configuring `match_fun` in `conn_opts` fails to build release
[#43](https://github.com/cabol/nebulex_redis_adapter/issues/43)
- Redis 7 issue
[#38](https://github.com/cabol/nebulex_redis_adapter/issues/38)
- Allow deletion of multiple keys
[#37](https://github.com/cabol/nebulex_redis_adapter/issues/37)

**Merged pull requests:**

- Log Cluster Connections Error
[#52](https://github.com/cabol/nebulex_redis_adapter/pull/52)
([mjquinlan2000](https://github.com/mjquinlan2000))
- [#49] New Redis Cluster management strategy
[#50](https://github.com/cabol/nebulex_redis_adapter/pull/50)
([cabol](https://github.com/cabol))
- [#45] Configurable codec to encode/decode Redis keys and values
[#46](https://github.com/cabol/nebulex_redis_adapter/pull/46)
([cabol](https://github.com/cabol))
- Fix `:otp_app` option in README.md
[#40](https://github.com/cabol/nebulex_redis_adapter/pull/40)
([nallwhy](https://github.com/nallwhy))

## [v2.2.0](https://github.com/cabol/nebulex_redis_adapter/tree/v2.2.0) (2022-03-13)

[Full Changelog](https://github.com/cabol/nebulex_redis_adapter/compare/v2.1.2...v2.2.0)
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,27 +21,27 @@ and [Redis cache example][nbx_redis_example].

## Installation

Add `nebulex_redis_adapter` to your list of dependencies in `mix.exs`:
Add `:nebulex_redis_adapter` to your list of dependencies in `mix.exs`:

```elixir
defp deps do
[
{:nebulex_redis_adapter, "~> 2.2"},
{:nebulex_redis_adapter, "~> 2.3"},
{:crc, "~> 0.10"}, #=> Needed when using Redis Cluster
{:jchash, "~> 0.1.2"} #=> Needed when using consistent-hashing
{:jchash, "~> 0.1.3"} #=> Needed when using consistent-hashing
]
end
```

In order to give more flexibility and loading only needed dependencies, this
adapter makes all its dependencies optional. For example:
The adapter dependencies are optional to give more flexibility and loading only
needed ones. For example:

* `:crc` - Required when using the adapter in mode `:redis_cluster`.
See [Redis Cluster][redis_cluster].
* `:jchash` - Required if you want to use consistent-hashing when using the
adapter in mode `:client_side_cluster`.

Then run `mix deps.get` in your shell to fetch the dependencies.
Then run `mix deps.get` to fetch the dependencies.

## Usage

Expand Down Expand Up @@ -108,7 +108,7 @@ config :my_app, MyApp.RedisClusterCache,

# For :redis_cluster mode this option must be provided
redis_cluster: [
# Configuration endpoint.
# Configuration endpoints
# This is where the client will connect and send the "CLUSTER SHARDS"
# (Redis >= 7) or "CLUSTER SLOTS" (Redis < 7) command to get the cluster
# information and set it up on the client side.
Expand Down
2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ defmodule NebulexRedisAdapter.MixProject do
use Mix.Project

@source_url "https://github.com/cabol/nebulex_redis_adapter"
@version "2.2.0"
@version "2.3.0"
@nbx_tag "2.5.0"
@nbx_vsn "2.5"

Expand Down

0 comments on commit ec641ba

Please sign in to comment.