Merge pull request #11 from telkins/telkins-patch-1

Added documentation on database connection...

README.md

@@ -63,22 +63,36 @@ This is the contents of the published config file:
 ```php
 return [
 
-    /*
-    |--------------------------------------------------------------------------
-    | Max Hops
-    |--------------------------------------------------------------------------
-    |
-    | This value represents the maximum number of hops that are allowed where
-    | hops "[i]ndicates how many vertex hops are necessary for the path; it is
-    | zero for direct edges".
-    |
-    | The more hops that are allowed (and used), then the more DAG edges will
-    | be created.  This will have an increasing impact on performance, space,
-    | and memory.  Whether or not it's negligible, noticeable, or impactful
-    | depends on a variety of factors.
-    */
+    /**
+     *-------------------------------------------------------------------------
+     * Max Hops
+     *-------------------------------------------------------------------------
+     *
+     * This value represents the maximum number of hops that are allowed where
+     * hops "[i]ndicates how many vertex hops are necessary for the path; it is
+     * zero for direct edges".
+     *
+     * The more hops that are allowed (and used), then the more DAG edges will
+     * be created.  This will have an increasing impact on performance, space,
+     * and memory.  Whether or not it's negligible, noticeable, or impactful
+     * depends on a variety of factors.
+     */
 
     'max_hops' => 5,
+
+    /**
+     *-------------------------------------------------------------------------
+     * Default Database Connection Name
+     *-------------------------------------------------------------------------
+     *
+     * This is the name of the database connection where the dag_edges table
+     * can be found.
+     *
+     * Set to `null` to use the default connection.
+     */
+
+    'default_database_connection_name' => null,
+
 ];
 ```