Skip to content

Commit c280f8d

Browse files
committed
feat: adjusted readme
1 parent 9bae233 commit c280f8d

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

Readme.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Getting started
22

3-
This scripts are used to easly create new dsc composite ressources.
3+
This scripts are used to easly create new XOAP PowerShell DSC composite resources.
44

55
## Prerequisites
66

@@ -13,25 +13,28 @@ Import-Module Plaster
1313

1414
## Creating new modules
1515

16-
Modules will be automatically created once you are creating a new composite ressource.
16+
Modules will be automatically created once you are creating a new composite resource.
1717

18-
## Creating new composite ressources
18+
## Creating new composite resources
1919

20-
Composite ressources can easily be deployed via the invocation of
20+
Composite resources can easily be deployed via the invocation of:
2121

2222
´´PowerShell
23-
.\New-CompositeRessource.ps1
23+
.\New-CompositeResource.ps1
2424
``
2525

2626
with parameters
2727

2828
´´PowerShell
29-
.\New-CompositeRessource.ps1 -Module W2K19DC1903Baseline -Version 1.0.0 -Ressource DSC_ScheduledTasks
29+
.\New-CompositeResource.ps1 -Module Template -Version 1.0.0 -Resource DSC_Template
3030
``
31+
32+
The prefix "XOAP" is automatically added and the postfix "DSC" as well.
33+
3134
The parameter list is as followed:
3235

33-
| Parameter | Description | Note |
34-
| --------- | -------------------------------------- | ---- |
35-
| Module | Name of the outer module part | - |
36-
| Version | Target version of the module | - |
37-
| Ressource | The name of the ressource /config part | - |
36+
| Parameter | Description | Note |
37+
| --------- | ------------------------------------- | ---- |
38+
| Module | Name of the outer module part | - |
39+
| Version | Target version of the module | - |
40+
| Resource | The name of the resource /config part | - |

0 commit comments

Comments
 (0)