Skip to content

Commit 7d674b2

Browse files
committed
Update readme
1 parent f49e6f6 commit 7d674b2

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,17 @@
1111

1212
### Current Version: 0.0.1-alpha
1313

14-
This is currently under heavy development. Until version 1.0.0 I do not expect to follow SemVer.
15-
I will try, but understand this library is subject to major changes until 1.0.0 or further adoption/notice.
14+
This is currently under heavy development and no release candidate has be marked at this point.
15+
You are free to use this in production with relatively low-risk as the library itself is fully functional,
16+
and is READ-ONLY so there should be no side-effects from its usage.
17+
18+
### [Documentation (WIP)](https://phpwintools.github.io/wmi-scripting/)
1619

1720
### Install
1821

1922
`composer require phpwintools/wmi-scripting`
2023

21-
### Usage
22-
23-
#### @Todo: Finish Docs
24+
### Basic Usage
2425

2526
Basic usage is to call `::query($connection = null)` on an available model from
2627
https://github.com/phpwintools/wmi-scripting/tree/master/src/WmiScripting/Models.
@@ -42,7 +43,7 @@ to guide me on how this query builder should look please contact me.
4243

4344
#### Testing
4445

45-
You can call `Scripting::fake($testCase)->win32Model($class_name);` to create a fake for testing without
46-
actually creating a real connection to a WMI service.
46+
This is still an area that is under development.
4747

48-
#### @Todo: Finish Docs
48+
You can call `Scripting::fake($testCase)->win32Model($class_name);` to create a fake for testing without
49+
actually creating a real connection to a WMI service.

docs/.vuepress/config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
module.exports = {
22
base: `/wmi-scripting/`,
33
title: 'WMI Scripting',
4-
description: 'WMI Scripting in PHP made easy.',
4+
description: 'WMI Scripting and Querying made easy.',
55

66
head: [
77
['link', { rel: 'icon', href: `/wmi-squares.png` }],

0 commit comments

Comments
 (0)