nebulex

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/elixir-nebulex/nebulex/main/guides/images/nbx-logo-white.png" />
  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/elixir-nebulex/nebulex/main/guides/images/nbx-logo.png" />
  <img src="https://raw.githubusercontent.com/elixir-nebulex/nebulex/main/guides/images/nbx-logo.png" alt="Nebulex logo" />
</picture>

> **In-memory and distributed caching toolkit for Elixir**

---

![CI](https://github.com/elixir-nebulex/nebulex/workflows/CI/badge.svg)
[![Codecov](https://codecov.io/gh/elixir-nebulex/nebulex/graph/badge.svg)](https://codecov.io/gh/elixir-nebulex/nebulex)
[![Hex.pm](https://img.shields.io/hexpm/v/nebulex.svg)](https://hex.pm/packages/nebulex)
[![Documentation](https://img.shields.io/badge/Documentation-ff69b4)](https://hexdocs.pm/nebulex)

## 🚀 About

Nebulex adds caching to Elixir applications. Like [Ecto][ecto], it is an
abstraction: you use different caching backends through the same API, with
little impact on your code.

You write against the Nebulex API instead of talking to [Redis][redis],
[Memcached][memcached], or an Elixir cache like [Cachex][cachex] directly.
Nebulex also comes with [declarative decorator-based caching][nbx_caching],
[cache usage patterns][cache_patterns], and
[distributed cache topologies][cache_topologies].

[ecto]: https://github.com/elixir-ecto/ecto
[cachex]: https://github.com/whitfin/cachex
[redis]: https://redis.io/
[memcached]: https://memcached.org/
[nbx_caching]: https://hexdocs.pm/nebulex/Nebulex.Caching.Decorators.html
[info_api]: https://hexdocs.pm/nebulex/info-api.html
[cache_patterns]: https://hexdocs.pm/nebulex/cache-usage-patterns.html
[cache_topologies]: https://docs.oracle.com/en/middleware/fusion-middleware/coherence/14.1.2/develop-applications/introduction-coherence-caches.html

---

> [!NOTE]
>
> This README refers to the main branch of Nebulex, not the latest released
> version on Hex. Please refer to the [getting started guide][getting_started]
> and the [official documentation][docs] for the latest stable release.

[getting_started]: https://hexdocs.pm/nebulex/getting-started.html
[docs]: https://hexdocs.pm/nebulex/Nebulex.html

---

## 📖 Usage

To use Nebulex, add both `:nebulex` and your chosen cache adapter as
dependencies in your `mix.exs` file.

> _**For more information about available adapters, check out the
> [Nebulex adapters][nbx_adapters] guide.**_

[nbx_adapters]: https://hexdocs.pm/nebulex/nbx-adapters.html

For example, to use the Generational Local Cache
(`Nebulex.Adapters.Local` adapter), add the following to your `mix.exs`:

```elixir
def deps do
  [
    {:nebulex, "~> 3.0"},
    {:nebulex_local, "~> 3.0"}, # Generational local cache adapter
    {:decorator, "~> 1.4"},     # Required for caching decorators
    {:telemetry, "~> 1.0"}      # Required for telemetry events
  ]
end
```

All dependencies are optional, including the adapters,