Updated Documentation and Example

Author: gesbeckj

Examples/xComputer/6-SetComputerDescriptionInWorkgroup.ps1

@@ -0,0 +1,24 @@
+<#
+    .EXAMPLE
+    This example will set the computer description
+#>
+Configuration Example
+{
+    param
+    (
+        [Parameter()]
+        [System.String[]]
+        $NodeName = 'localhost'
+    )
+
+    Import-DscResource -Module xComputerManagement
+
+    Node $NodeName
+    {
+        xComputer NewDescription
+        {
+            Name = 'localhost'
+            Description = 'This is my computer.'
+        }
+    }
+}

README.md

@@ -53,6 +53,7 @@ xComputer resource has following properties:
 * Credential: Credential to be used to join or leave domain
 * CurrentOU: A read-only property that specifies the organizational unit that
   the computer account is currently in
+* Description: The local computer descrption
 
 ### xComputer Examples
 
@@ -61,6 +62,7 @@ xComputer resource has following properties:
 * [Set the Name while staying on the Domain](/Examples/xComputer/3-RenameComputerInDomain.ps1)
 * [Set the Name while staying on the Workgroup](/Examples/xComputer/4-RenameComputerInWorkgroup.ps1)
 * [Switch from a Domain to a Workgroup](/Examples/xComputer/5-UnjoinDomainAndJoinWorkgroup.ps1)
+* [Set a Description for the Workstation](/Examples/xComputer/6-SetComputerDescriptionInWorkgroup.ps1)
 
 ## xOfflineDomainJoin
 
@@ -202,6 +204,9 @@ xVirtualMemory has the following properties:
 
 ### Unreleased
 
+* xComputer: Added parameter to set the local computer description along with documentation
+ and unit tests for this change.
+
 ### 2.1.0.0
 
 * xComputer: Changed comparison that validates if we are in the correct AD