Merge pull request #4 from unenglishable/readme

update README, add supervision tree info
alexfilatov · Mar 16, 2023 · c61776b · c61776b
2 parents 4db9df7 + 692c4cc
commit c61776b
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -32,6 +32,24 @@ config :guardian, Guardian.DB,
        repo: GuardianRedis.Repo # Add this Redis repository module
 ```
 
+Add GuardianRedis.Redix to your supervision tree:
+
+(Note: If this is not configured you will get a `no process` error when storing or revoking tokens!)
+
+```elixir
+defmodule MyApp.Application do
+
+  # ...
+
+  defp my_app_otp_apps() do
+    children = [
+      MyApp.Repo,
+      GuardianRedis.Redix
+    ]
+  end
+end
+```
+
 Apart from this please set up Redis configuration:
 
 ```elixir