Overall updates

Author: cabol

.github/workflows/ci.yml

@@ -22,23 +22,18 @@ jobs:
           - elixir: 1.18.x
             otp: 27.x
             os: 'ubuntu-latest'
-            style: true
+            lint: true
             coverage: true
-            sobelow: true
             dialyzer: true
-            doctor: true
           - elixir: 1.17.x
-            otp: 26.x
-            os: 'ubuntu-latest'
-          - elixir: 1.16.x
-            otp: 26.x
+            otp: 27.x
             os: 'ubuntu-latest'
-          - elixir: 1.15.x
+          - elixir: 1.17.x
             otp: 25.x
             os: 'ubuntu-latest'
           - elixir: 1.14.x
-            otp: 23.x
-            os: 'ubuntu-20.04'
+            otp: 24.x
+            os: 'ubuntu-latest'
 
     env:
       GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
@@ -86,14 +81,22 @@ jobs:
           mix deps.get
         if: ${{ steps.mix-cache.outputs.cache-hit != 'true' }}
 
-      - name: Compile code
+      - name: Compile deps
+        run: mix deps.compile
+
+      - name: Check unused dependencies
+        run: mix deps.unlock --check-unused
+        if: ${{ matrix.lint }}
+
+      - name: Compile lint
         run: mix compile --warnings-as-errors
+        if: ${{ matrix.lint }}
 
       - name: Run style and code consistency checks
         run: |
           mix format --check-formatted
           mix credo --strict
-        if: ${{ matrix.style }}
+        if: ${{ matrix.lint }}
 
       - name: Run tests
         run: |

LICENSE renamed to LICENSE.md

@@ -1,4 +1,4 @@
-MIT License
+# MIT License
 
 Copyright (c) 2024 Carlos Andres Bolaños R.A.
 

README.md

@@ -4,13 +4,21 @@
 [Nebulex]: https://github.com/cabol/nebulex
 
 ![CI](https://github.com/elixir-nebulex/nebulex_distributed/workflows/CI/badge.svg)
-[![Documentation](https://img.shields.io/badge/Documentation-ff69b4)](https://hexdocs.pm/nebulex_distributed)
-[![Hex Version](https://img.shields.io/hexpm/v/nebulex_distributed.svg)](https://hex.pm/packages/nebulex_distributed)
 [![Codecov](https://codecov.io/gh/elixir-nebulex/nebulex_distributed/graph/badge.svg)](https://codecov.io/gh/elixir-nebulex/nebulex_distributed/graph/badge.svg)
+[![Hex Version](https://img.shields.io/hexpm/v/nebulex_distributed.svg)](https://hex.pm/packages/nebulex_distributed)
+[![Documentation](https://img.shields.io/badge/Documentation-ff69b4)](https://hexdocs.pm/nebulex_distributed)
 
-See the [online documentation][online_docs] for more information.
+One of the goals of Nebulex is also to provide the ability to set up distributed
+cache topologies, but this feature will depend on the adapters. Here is where
+**"Nebulex Distributed"** comes in. It provides the following adapters to set up
+distributed topologies:
 
-[online_docs]: https://hexdocs.pm/nebulex_distributed/
+    * `Nebulex.Adapters.Partitioned` - Partitioned cache topology.
+    * `Nebulex.Adapters.Multilevel` - Multi-level distributed cache topology.
+
+These adapters work more as wrappers for an existing local adapter and provide
+the distributed topology on top of it. You can optionally set the adapter for
+the primary cache storage with the option `:primary_storage_adapter`.
 
 ## Installation
 
@@ -19,7 +27,7 @@ Add `:nebulex_distributed` to your list of dependencies in `mix.exs`:
 ```elixir
 def deps do
   [
-    {:nebulex_distributed, "~> 3.0"}
+    {:nebulex_distributed, "~> 3.0.0-rc.0"}
   ]
 end
 ```
@@ -67,6 +75,8 @@ end
 
 See the [online documentation][online_docs] for more information.
 
+[online_docs]: https://hexdocs.pm/nebulex_distributed/
+
 ## Testing
 
 Since this adapter uses support modules and shared tests from `Nebulex`,
@@ -116,7 +126,7 @@ the directory [benchmarks](./benchmarks).
 To run a benchmark test you have to run:
 
 ```
-$ MIX_ENV=test mix run benchmarks/{BENCH_TEST_FILE}
+$ MIX_ENV=test mix run benchmarks/BENCH_TEST_FILE
 ```
 
 Where `BENCH_TEST_FILE` can be any of:
@@ -144,4 +154,4 @@ all checks run successfully.
 
 Copyright (c) 2024 Carlos Andres Bolaños R.A.
 
-`Nebulex.Adapters.Local` source code is licensed under the [MIT License](LICENSE).
+`nebulex_distributed` source code is licensed under the [MIT License](LICENSE).