Skip to content

Commit

Permalink
fix: adjusted readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ssokolic committed Nov 28, 2023
1 parent 5503d56 commit 324fb48
Showing 1 changed file with 5 additions and 47 deletions.
52 changes: 5 additions & 47 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,55 +12,8 @@ Please check out common DSC Community [contributing guidelines](https://dsccommu

## Change log

<<<<<<< HEAD
A full list of changes in each version can be found in the [change log](CHANGELOG.md).

## Documentation

This script is used to easily create new DSC modules and resources.

## Prerequisites

Please install Plaster first and make sure it's present.

```powershell
Install-Module Plaster
Import-Module Plaster
```

## Create new DSC modules

Modules will be automatically created once you are creating a new DSC resource.

## Create new DSC resources

DSC resources can easily be deployed via the invocation of

```powershell
.\New-CompositeResource.ps1
```

with parameters

```powershell
.\New-CompositeResource.ps1 -Module XOAPModuleTemplateDSC -Version 0.0.1 -Resource ScheduledTasks
```

The parameter list is as followed:

| Parameter | Description | Note |
|-----------|----------------------------------------|------|
| Module | Name of the outer module part | - |
| Version | Target version of the module | - |
| Ressource | The name of the ressource /config part | - |

### Examples

You can review the [Examples](/Examples/Resources) directory in the **XOAPModuleTemplateDSC** module
for some general use scenarios for all the resources that are in the module.
=======
A full list of changes in each version can be found in the [Releases](https://github.com/xoap-io/XOAPFSLogixDSC/releases).

## Prerequisites

Be sure that the following DSC modules are installed on your system:
Expand All @@ -72,6 +25,11 @@ Be sure that the following DSC modules are installed on your system:

The XOAP FSLogix DSC module contains the following resources:

- XOAP_AddToRemoteDesktopUsersGroup
- XOAP_ConfigureFSLogixSettings
- XOAP_CreateFRXShare
- XOAP_FSLogixQuickStartConfiguration

### XOAP_AddToRemoteDesktopUsersGroup

```PowerShell
Expand Down

0 comments on commit 324fb48

Please sign in to comment.