Release v2.0.0-rc.2

CHANGELOG.md

@@ -1,5 +1,56 @@
 # Changelog
 
+## [v2.0.0-rc.2](https://github.com/cabol/nebulex/tree/v2.0.0-rc.2) (2021-01-06)
+
+[Full Changelog](https://github.com/cabol/nebulex/compare/v2.0.0-rc.1...v2.0.0-rc.2)
+
+**Added features:**
+
+- Adapter `Nebulex.Adapters.Nil` for disabling caching
+  [#88](https://github.com/cabol/nebulex/issues/88)
+- Adapter for `whitfin/cachex`
+  [#20](https://github.com/cabol/nebulex/issues/20)
+
+**Implemented enhancements:**
+
+- Improve replicated adapter to ensure better consistency across the nodes
+  [#99](https://github.com/cabol/nebulex/issues/99)
+- Refactor and/or improve Nebulex task for generating caches
+  [#97](https://github.com/cabol/nebulex/issues/97)
+- Add `Nebulex.Adapter.Stats` behaviour as optional
+  [#95](https://github.com/cabol/nebulex/issues/95)
+- Add `Nebulex.Adapter.Entry` and `Nebulex.Adapter.Storage` behaviours
+  [#93](https://github.com/cabol/nebulex/issues/93)
+- Add `:default` option to the `incr/3` callback
+  [#92](https://github.com/cabol/nebulex/issues/92)
+- Use `:erpc` when depending on OTP 23 or higher, otherwise use current
+  implementation [#91](https://github.com/cabol/nebulex/issues/91)
+
+**Fixed bugs:**
+
+- Update evictions stats when a new generation is created and the older is
+  deleted [#98](https://github.com/cabol/nebulex/issues/98)
+
+**Closed issues:**
+
+- Is there a way to disable caching entirely?
+  [#87](https://github.com/cabol/nebulex/issues/87)
+- Slow cache under moderate simultaneous load
+  [#80](https://github.com/cabol/nebulex/issues/80)
+- `mix nebulex.gen.cache` replaces everything in folder
+  [#75](https://github.com/cabol/nebulex/issues/75)
+- Replicated hash_slots for partitioned adapter
+  [#65](https://github.com/cabol/nebulex/issues/65)
+
+**Merged pull requests:**
+
+- Overall fixes and enhancements for adapter behaviours
+  [#94](https://github.com/cabol/nebulex/pull/94)
+  ([cabol](https://github.com/cabol))
+- Typo in code example 👀
+  [#89](https://github.com/cabol/nebulex/pull/89)
+  ([Awlexus](https://github.com/Awlexus))
+
 ## [v2.0.0-rc.1](https://github.com/cabol/nebulex/tree/v2.0.0-rc.1) (2020-11-15)
 
 [Full Changelog](https://github.com/cabol/nebulex/compare/v2.0.0-rc.0...v2.0.0-rc.1)

README.md

@@ -1,9 +1,8 @@
 # Nebulex 🌌
-> ### In-Process and Distributed Cache Toolkit for Elixir.
-> Easily craft and deploy distributed cache topologies and cache usage patterns.
+> In-memory and distributed caching toolkit for Elixir.
 
 ![CI](https://github.com/cabol/nebulex/workflows/CI/badge.svg)
-[![Coverage Status](https://coveralls.io/repos/github/cabol/nebulex/badge.svg?branch=master)](https://coveralls.io/github/cabol/nebulex?branch=master)
+[![Coverage Status](https://img.shields.io/coveralls/cabol/nebulex.svg)](https://coveralls.io/github/cabol/nebulex)
 [![Inline docs](http://inch-ci.org/github/cabol/nebulex.svg)](http://inch-ci.org/github/cabol/nebulex)
 [![Hex Version](https://img.shields.io/hexpm/v/nebulex.svg)](https://hex.pm/packages/nebulex)
 [![Docs](https://img.shields.io/badge/docs-hexpm-blue.svg)](https://hexdocs.pm/nebulex)
@@ -12,22 +11,24 @@
 Nebulex provides support for transparently adding caching into an existing
 Elixir application. Similar to [Ecto][ecto], the caching abstraction allows
 consistent use of various caching solutions with minimal impact on the code.
-Furthermore, it enables the implementation of different
-[cache usage patterns][cache_patterns],
-[distributed cache topologies][cache_topologies],
-and more.
 
-Nebulex is commonly used to interact with different cache implementations and/or
-stores (such as Redis, Memcached, or even other Elixir cache implementations
-like [Cachex][cachex]), being completely agnostic from them, avoiding the vendor
-lock-in.
+Nebulex cache abstraction shields developers from directly dealing with the
+underlying caching implementations, such as [Redis][redis],
+[Memcached][memcached], or even other Elixir cache implementations like
+[Cachex][cachex]. Furthermore, several interesting and useful features like
+[cache usage patterns][cache_patterns],
+[declarative annotation-based caching][nbx_caching], and
+[distributed cache topologies][cache_topologies] are available out-of-box.
 
 See the [getting started guide](http://hexdocs.pm/nebulex/getting-started.html)
 and the [online documentation](http://hexdocs.pm/nebulex/Nebulex.html)
 for more information.
 
 [ecto]: https://github.com/elixir-ecto/ecto
 [cachex]: https://github.com/whitfin/cachex
+[redis]: https://redis.io/
+[memcached]: https://memcached.org/
+[nbx_caching]: http://hexdocs.pm/nebulex/Nebulex.Caching.html
 [cache_patterns]: https://github.com/ehcache/ehcache3/blob/master/docs/src/docs/asciidoc/user/caching-patterns.adoc
 [cache_topologies]: https://docs.oracle.com/middleware/1221/coherence/develop-applications/cache_intro.htm
 
@@ -62,7 +63,7 @@ For example, if you want to use a built-in cache, add to your `mix.exs` file:
 ```elixir
 def deps do
   [
-    {:nebulex, "2.0.0-rc.1"},
+    {:nebulex, "2.0.0-rc.2"},
     {:shards, "~> 1.0"},     #=> When using :shards as backend
     {:decorator, "~> 1.3"},  #=> When using Caching Annotations
     {:telemetry, "~> 0.4"}   #=> When using the Telemetry events (Nebulex stats)
@@ -88,7 +89,6 @@ makes all dependencies optional. For example:
   * If you are using an adapter other than the built-in ones (e.g: Cachex or
     Redis adapters), you have to add that dependency too.
 
-[nbx_caching]: http://hexdocs.pm/nebulex/Nebulex.Caching.html
 [telemetry]: http://hexdocs.pm/nebulex/telemetry.html
 
 Then run `mix deps.get` in your shell to fetch the dependencies. If you want to

guides/getting-started.md

@@ -29,7 +29,7 @@ changing the `deps` definition in that file to this:
 ```elixir
 defp deps do
   [
-    {:nebulex, "2.0.0-rc.1"},
+    {:nebulex, "2.0.0-rc.2"},
     {:shards, "~> 1.0"},      #=> When using :shards as backend
     {:decorator, "~> 1.3"},   #=> When using Caching Annotations
     {:telemetry, "~> 0.4"}    #=> When using the Telemetry events (Nebulex stats)

guides/telemetry.md

@@ -28,7 +28,7 @@ and `:telemetry_poller` packages:
 ```elixir
 def deps do
   [
-    {:nebulex, "2.0.0-rc.1"},
+    {:nebulex, "2.0.0-rc.2"},
     {:shards, "~> 1.0"},
     {:decorator, "~> 1.3"},
     {:telemetry, "~> 0.4"},

mix.exs

@@ -2,7 +2,7 @@ defmodule Nebulex.MixProject do
   use Mix.Project
 
   @source_url "https://github.com/cabol/nebulex"
-  @version "2.0.0-rc.1"
+  @version "2.0.0-rc.2"
 
   def project do
     [
@@ -13,10 +13,6 @@ defmodule Nebulex.MixProject do
       aliases: aliases(),
       deps: deps(),
 
-      # Docs
-      name: "Nebulex",
-      docs: docs(),
-
       # Testing
       test_coverage: [tool: ExCoveralls],
       preferred_cli_env: [
@@ -31,11 +27,12 @@ defmodule Nebulex.MixProject do
       dialyzer: dialyzer(),
 
       # Hex
+      description: "In-memory and distributed caching toolkit for Elixir",
       package: package(),
-      description: """
-      In-Process and Distributed Caching Toolkit for Elixir. Easily craft and
-      deploy distributed cache topologies and different cache usage patterns.
-      """
+
+      # Docs
+      name: "Nebulex",
+      docs: docs()
     ]
   end