Update docs

Author: jspringe

docs/.vuepress/config.js

@@ -22,16 +22,23 @@ module.exports = {
         sidebar: {
             '/documentation': [
                 {
-                    title: 'Documentation',
+                    title: 'Quick Start',
                     collapsable: false,
                     children: [
                         ['documentation/', 'How It Works'],
                         ['documentation/getting-started', 'Getting Started'],
-                        ['documentation/configuration', 'Configuration'],
-                        ['documentation/the-config-instance', 'The Config Instance'],
+                        // ['documentation/configuration', 'Configuration'],
                     ]
-                }
-            ]
+                },
+                {
+                    title: 'Digging Deeper',
+                    collapsable: false,
+                    children: [
+                        ['documentation/digging-deeper/', 'Introduction'],
+                        ['documentation/digging-deeper/the-config-instance', 'The Config Instance'],
+                    ]
+                },
+            ],
         }
     }
 };

docs/documentation/configuration.md

@@ -0,0 +1,4 @@
+# Introduction
+
+The following section will dive into the internals of the library. You typically do not need to dive this
+deep, but I feel it would be good to document it for all of our benefit.

docs/documentation/digging-deeper/readme.md

@@ -1,4 +1,4 @@
-## The Configuration Instance
+# The Config Instance
 
 The configuration instance, `Config`, is the core of this library. Upon instantiation of, either a model or `Scripting`,
 an instance of `Config` gets created.
@@ -7,7 +7,7 @@ an instance of `Config` gets created.
 Due to the usage of this pattern you typically would not `new` the `Config` object directly. However, if you feel
 you need to access the `Config` directly you should do so using the `::instance()` static method.
 
-### Defaults
+## Defaults
 
 The only default that is currently expected to be used is the default `Connection`. This is set to the local machine
 that `PHP` is running on.
@@ -75,10 +75,11 @@ allows you to make global changes.
 $config = Config::instance();
 ```
 
-### Config Methods
+## Config Methods
 
 While not all of the `Config` methods are outlined here below are the ones that may be most useful to you.
 
+### instance
 #### `Config::instance(array $items = [], Resolver $resolver = null)`
 
 If called without any arguments this will either return the currently instantiated instance or return a new instance
@@ -89,6 +90,7 @@ If called with the `$items` array set this will merge the given configuration in
 If called with `$resolver` set then it will replace the current `Resolver` instance with the one given. You shouldn't
 need to override this, but it could be useful when testing.
 
+### newInstance
 #### `Config::newInstance(array $items = [], Resolver $resolver = null)`
 
 Operates the same as above with the exception that this will always return a brand new instance. This is also useful
@@ -107,26 +109,32 @@ class FeatureTest extends TestCase
 }
 ```
 
+### getConnection
 #### `$config->getConnection(string $name = null)`
 
 Returns a connection from the `Config` container by name. If `$name` is not provided or set to `'default'` then it will
 return the default connection.
 
 If a connection is not found it will simply return `null`.
 
+### addConnection
 #### `$config->addConnection(string $name, Connection $connection)`
 
 Add a connection to the `Config` instance.
 
+### setDefaultConnection
 #### `$config->setDefaultConnection(string $name)`
 
 This will set the default connection by its name. If the connection name does not exist then it will throw an 
 `InvalidConnectionException`.
 
-#### `$config->getDefaultConnection()`
-
-Returns the currently set default connection.
 
+### getDefaultConnectionName
 #### `$config->getDefaultConnectionName()`
 
 Returns the currently set default connection name.
+
+### getDefaultConnection
+#### `$config->getDefaultConnection()`
+
+Returns the currently set default connection.

docs/documentation/the-config-instance.md …on/digging-deeper/the-config-instance.mddocs/documentation/the-config-instance.md renamed to docs/documentation/digging-deeper/the-config-instance.md docs/documentation/the-config-instance.md renamed to docs/documentation/digging-deeper/the-config-instance.md

@@ -10,4 +10,79 @@ Windows and the `com_dotnet` extension enabled (available in every [`Windows PHP
 ## Install
 ``` sh
 composer require phpwintools/wmi-scripting
-```
+```
+
+## Basic Configuration
+
+There isn't much configuration that needs to be done to get started with this library. You only need to set the
+connections before using this in your own application.
+
+### Local Connection
+``` php
+// Returns a ModelCollection of LoggedOnUser models from the local machine
+$local = LoggedOnUser::query()->get();
+
+$scripting = new Scripting;
+// Same as above
+$local = $scripting->query()->loggedOnUser()->get();
+```
+
+If no configuration is provided then the library's default connection is localhost.
+
+### Static call on Win32Model class
+``` php
+$connection = Connection::simple('computer-one', 'admin', 'password');
+
+// Returns an instance of Query\Builder
+$builder = LoggedOnUser::query($connection);
+
+// Returns a ModelCollection of Models\LoggedOnUsers
+$loggedOnUsers = $builder->get();
+```
+
+A connection defined in this way will not be stored in the `Config` container. This is useful when you need to reference
+many connections in an array to poll many computers across your network.
+
+``` php
+$username = 'admin';
+$password = 'password';
+$computers = ['computer_one', 'computer_two'];
+
+$results = [];
+
+foreach ($computers as $computer) {
+    // $results becomes an array of ModelCollections
+    $results[] = LoggedOnUser::query(Connection::simple($computer, $user $password));
+}
+```
+
+### With `Scripting` Class
+``` php
+$scripting = new Scripting(Connection::simple('computer-one', 'admin', 'password));
+
+// Returns and instance of Query\Builder (same as above)
+$builder = $scripting->query()->loggedOnUser();
+```
+
+This will set the given connection as the default connection. All models queried without a given connection will use
+this connection.
+
+``` php
+$scripting = new Scripting;
+$scripting->addConnection(
+    'computer-one',
+    Connection::simple('computer-one', 'admin', 'password')
+);
+
+$builder = $scripting->query('computer-one)->loggedOnUser();
+
+// This connection is also available to the Models
+$builder = LoggedOnUser::query('computer-one');
+```
+
+Adding a connection in this way will store the connection for later and repeated use.
+
+::: danger
+`Scripting` should only be instantiated once. If it is instantiated more than once then the last configuration options
+will be used.
+:::