OfficeOnlineServerDsc: Update the README (#69)

CHANGELOG.md

@@ -8,12 +8,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - OfficeOnlineServerDsc
--   Imports DscResource.Common module
+  - Imports DscResource.Common module
 
 ### Changed
 
 - OfficeOnlineServerDsc
-  - Updated to latest pipeline files.
+  - Updated to latest pipeline files
+  - Update the README so that it says that this module should also support
+    to configure Office Online Server.
 - All resources
   - Get-LocalizedData from DscResource.Common is now used
 

README.md

@@ -2,50 +2,41 @@
 
 [![Build Status](https://dev.azure.com/dsccommunity/OfficeOnlineServerDsc/_apis/build/status/dsccommunity.OfficeOnlineServerDsc?branchName=master)](https://dev.azure.com/dsccommunity/OfficeOnlineServerDsc/_build/latest?definitionId=29&branchName=master)
 ![Azure DevOps coverage (branch)](https://img.shields.io/azure-devops/coverage/dsccommunity/OfficeOnlineServerDsc/29/master)
+[![codecov](https://codecov.io/gh/dsccommunity/OfficeOnlineServerDsc/branch/master/graph/badge.svg)](https://codecov.io/gh/dsccommunity/OfficeOnlineServerDsc)
 [![Azure DevOps tests](https://img.shields.io/azure-devops/tests/dsccommunity/OfficeOnlineServerDsc/29/master)](https://dsccommunity.visualstudio.com/OfficeOnlineServerDsc/_test/analytics?definitionId=29&contextType=build)
 [![PowerShell Gallery (with prereleases)](https://img.shields.io/powershellgallery/vpre/OfficeOnlineServerDsc?label=OfficeOnlineServerDsc%20Preview)](https://www.powershellgallery.com/packages/OfficeOnlineServerDsc/)
 [![PowerShell Gallery](https://img.shields.io/powershellgallery/v/OfficeOnlineServerDsc?label=OfficeOnlineServerDsc)](https://www.powershellgallery.com/packages/OfficeOnlineServerDsc/)
 
-The OfficeOnlineServerDsc module provides the ability to install Office Online
-Server (formerly known as Office Web App Server).
+This module contains DSC resources for deployment and configuration of Office Online Server (formerly known as Office Web App Server).
 
-## Contributing
-
-Please check out common DSC Community [contributing guidelines](https://dsccommunity.org/guidelines/contributing).
-
-## Installation
-
-To manually install the module, download the source code and unzip the contents
-of the \Modules\OfficeOnlineServerDsc directory to the
-$env:ProgramFiles\WindowsPowerShell\Modules folder.
+## Code of Conduct
 
-To install from the PowerShell gallery using PowerShellGet (in PowerShell 5.0)
-run the following command:
+This project has adopted this [Code of Conduct](CODE_OF_CONDUCT.md).
 
-    Find-Module -Name OfficeOnlineServerDsc -Repository PSGallery | Install-Module
+## Releases
 
-To confirm installation, run the below command and ensure you see the Office
-Online Server DSC resoures available:
+For each merge to the branch `master` a preview release will be
+deployed to [PowerShell Gallery](https://www.powershellgallery.com/).
+Periodically a release version tag will be pushed which will deploy a
+full release to [PowerShell Gallery](https://www.powershellgallery.com/).
 
-    Get-DscResource -Module OfficeOnlineServerDsc
+## Contributing
 
-## Requirements
+Please check out common DSC Community [contributing guidelines](https://dsccommunity.org/guidelines/contributing).
 
-The minimum PowerShell version required is 4.0, which ships in Windows 8.1 or
-Windows Server 2012R2 (or higher versions). The preferred version is PowerShell
-5.0 or higher, which ships with Windows 10 or Windows Server 2016.
+## Change log
 
-## Changelog
+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 [change log](CHANGELOG.md)
+## Documentation
 
-## Code of Conduct
+The documentation can be found in the [OfficeOnlineServerDsc Wiki](https://github.com/dsccommunity/OfficeOnlineServerDsc/wiki).
+The DSC resources schema files is used to automatically update the
+documentation on each PR merge.
 
-This project has adopted this [Code of Conduct](CODE_OF_CONDUCT.md).
+### Examples
 
-## Releases
+You can review the [Examples](/src/Examples) directory
+for some general use scenarios for all of the resources that are in the module.
 
-For each merge to the branch `master` a preview release will be
-deployed to [PowerShell Gallery](https://www.powershellgallery.com/).
-Periodically a release version tag will be pushed which will deploy a
-full release to [PowerShell Gallery](https://www.powershellgallery.com/).
+The resource examples are also available in the [OfficeOnlineServerDsc Wiki](https://github.com/dsccommunity/SqlServerDsc/wiki).