diff --git a/Readme.md b/Readme.md index 77c6892..a4341be 100644 --- a/Readme.md +++ b/Readme.md @@ -1,6 +1,6 @@ -# XOAPModuleTemplateDSC +# XOAPW11SecurityBaseline22H2DSC -This repository is a template that can be used as a starting point for creating new DSC modules and resources. +This repository contains the DSC resources for the Windows 11 Security Baseline based on Microsoft recommendations from the [Microsoft Security Compliance Toolkit 1.0](https://learn.microsoft.com/en-us/windows/security/operating-system-security/device-management/windows-security-configuration-framework/security-compliance-toolkit-10). ## Code of Conduct @@ -8,52 +8,16 @@ This project has adopted this [Code of Conduct](CODE_OF_CONDUCT.md). ## Contributing -Please check out common DSC Community [contributing guidelines](https://dsccommunity.org/guidelines/contributing). +If you want to contribute please file a **New issue** [Issues](https://github.com/xoap-io/XOAPW11SecurityBaseline22H2DSC/issues). Before doing so, please have a look at the [Contributing Guidelines](CONTRIBUTING.md). -## Change log +## Change log and Releases -A full list of changes in each version can be found in the [change log](CHANGELOG.md). +A full list of changes in each version can be found in the [Releases](https://github.com/xoap-io/XOAPW11SecurityBaseline22H2DSC/releases). ## Documentation -This script is used to easily create new DSC modules and resources. +You can download the latest version of the documentation from the [Releases](https://github.com/xoap-io/XOAPW11SecurityBaseline22H2DSC/releases) page. +If you want to manually integrate the DSC Module on your node, copy the contents of the **XOAPW11SecurityBaseline22H2DSC** folder to **C:\Program Files\WindowsPowerShell\Modules**. +Be sure to adjust the path to your needs and the versions of the modules. -## 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. +If you want to use it with [XOAP](https://xoap.io) and config.XO. Upload the zip-file from the releases page to your config.XO Workspace. See [XOAP Documentation](https://docs.xoap.io/configuration-management/overview/modules/add-modules/) for more information.