Skip to content

Commit dafa3a6

Browse files
committed
Update docs
1 parent 82dca13 commit dafa3a6

File tree

3 files changed

+14
-9
lines changed

3 files changed

+14
-9
lines changed

docs/documentation/digging-deeper/the-config-instance.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# The Config Instance
22

3-
The configuration instance, `Config`, is the core of this library. Upon instantiation of, either a model or `Scripting`,
4-
an instance of `Config` gets created.
3+
The configuration instance, `Config`, is the core of this library. Upon instantiation of a model or the `Scripting`
4+
object an instance of `Config` will be created.
55

6-
`Config` uses a singleton-like pattern to make querying on a model directly possible.
7-
Due to the usage of this pattern you typically would not `new` the `Config` object directly. However, if you feel
6+
`Config` uses a singleton-like pattern to make directly querying on a model possible.
7+
Due to the usage of this pattern, you typically would not `new` the `Config` object directly. However, if you feel
88
you need to access the `Config` directly you should do so using the `::instance()` static method.
99

1010
## Defaults
1111

12-
The only default setting that I'm currently outlining is the connection. If not defined then the default connection is
12+
The only default setting that I'm currently outlining are the connection. If not defined, the default connection is
1313
the machine that is currently running PHP.
1414

1515
``` php
@@ -64,8 +64,9 @@ new Config($connections);
6464
```
6565

6666
Either method above will instantiate the `Config` object to be used later. Again, be sure to do this prior to any
67-
calls to assure predictable behavior. If you use `Config::instance($connections)` the new connections will simply be
68-
merged in to an already started instance, if one exists, or a new instance will be started with the given configuration.
67+
calls to `Config` to assure predictable behavior. If you use `Config::instance($connections)` the new connections will
68+
simply be merged i to an already started instance, if one exists, or a new instance will be started with the given
69+
configuration.
6970

7071
Accessing the configuration object in the following way keeps you from trampling over the current configuration and
7172
allows you to make global changes.

docs/documentation/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ $scripting = new Scripting;
2727
$local = $scripting->query()->loggedOnUser()->get();
2828
```
2929

30-
If no configuration is provided then the library's default connection is localhost.
30+
If no configuration is provided, the library's default connection is localhost.
3131

3232
### Static call on Win32Model class
3333
``` php

docs/documentation/readme.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Introduction
1+
# How It Works
22

33
The basic goal of this library is to make querying information from Windows systems on your network as easy as possible.
44
This is accomplished by adopting an active record approach similar to
@@ -14,6 +14,10 @@ I also take advantage of [Laravel's Collections](https://laravel.com/docs/5.8/co
1414
query a model you will get back an instance of `ModelCollection` which extends Laravel's `Collection`. This allows for
1515
fluent access to this data: `$modelCollection->map->getAttribute('name);` returns a collection of only the model names.
1616

17+
The Win32Models extend either another Win32 model, or more likely, a
18+
[CIM](https://docs.microsoft.com/en-us/windows/win32/cimwin32prov/cimwin32-wmi-providers) object. This follows the way
19+
that Win32 models are composed.
20+
1721
## Todo
1822

1923
I'm still working through the API and some of the core code to make this library as clean and resilient as possible.

0 commit comments

Comments
 (0)