Add docs to supervision tree

loopsocial · Jun 11, 2024 · 05dd745 · 05dd745
1 parent cf60d31
commit 05dd745
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -46,3 +46,13 @@ def deps do
   ]
 end
 ```
+
+Add the following to your supervision tree:
+
+```elixir
+children = [
+  EredisSub
+]
+```
+
+Optional configuration can be passed to `eredis` and `eredis_sub`, check [their docs](https://hexdocs.pm/eredis/readme.html#connect-a-client-start_link-1).
diff --git a/lib/eredis_sub.ex b/lib/eredis_sub.ex
@@ -26,6 +26,14 @@ defmodule EredisSub do
 
       metadata_example = %{subscribed_at: DateTime.utc_now()}
       EredisSub.Server.subscribe("my_channel", {MyModule, :handle, metadata_example})
+
+  ### Add the following to your supervision tree:
+
+      children = [
+        EredisSub
+      ]
+
+  Optional configuration can be passed to `eredis` and `eredis_sub`, check [their docs](https://hexdocs.pm/eredis/readme.html#connect-a-client-start_link-1).
   """
   alias EredisSub.Server