Be more specific about how to start the client

tchoutri · Feb 27, 2018 · 900d7ff · 900d7ff
1 parent b3c8e44
commit 900d7ff
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/lib/botfuel.ex b/lib/botfuel.ex
@@ -5,7 +5,11 @@ defmodule Botfuel do
 
   alias Botfuel.{Entity,Classify}
 
-  @doc "Creates a new client process with the provided API credentials"
+  @doc """
+  Creates a new client process with the provided API `app_id` and `app_key` as a map.
+  The `Botfuel.Client` module can be started by hand in a supervision tree as well, without much more ceremony.
+  API id and key retrieval are left to the user according to their method of choice (config.ex, environment variables, HashiCorp Vault, etc).
+  """
   def new_client(credentials) do
     Botfuel.Client.start_link(credentials)
   end