(GH-126) Document WinRM envelope size known issue

readme.md

@@ -3,26 +3,23 @@
 | master        | [![Build status](https://ci.appveyor.com/api/projects/status/qma3jnh23w5vjt46/branch/master?svg=true&passingText=master%20-%20OK&pendingText=master%20-%20PENDING&failingText=master%20-%20FAILED)](https://ci.appveyor.com/project/LawrenceGripper/cchoco/branch/master) |
 | development           | [![Build status](https://ci.appveyor.com/api/projects/status/qma3jnh23w5vjt46/branch/development?svg=true&passingText=development%20-%20OK&pendingText=development%20-%20PENDING&failingText=development%20-%20FAILED)](https://ci.appveyor.com/project/LawrenceGripper/cchoco/branch/development) |
 
-Community Chocolatey DSC Resource
-=============================
+# Community Chocolatey DSC Resource
 
 [![Join the chat at https://gitter.im/chocolatey/cChoco](https://badges.gitter.im/chocolatey/cChoco.svg)](https://gitter.im/chocolatey/cChoco?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-This resource is aimed at getting and installing packages from the choco gallery.
+This resource is aimed at getting and installing packages using Chocolatey.
 
 The resource takes the name of the package and will then install that package.
 
 See [ExampleConfig.ps1](ExampleConfig.ps1) for example usage.
 
 See list of packages here: https://chocolatey.org/packages
 
-Contributing
-=============================
+## Contributing
 
-Happy to accept new features and fixes. Outstanding issues which can be worked on tagged HelpedWanted under issues.
+Happy to accept new features and fixes. Outstanding issues which can be worked on tagged `Up For Grabs` under issues.
 
-Submitting a PR
-=============================
+### Submitting a PR
 
 Here's the general process of fixing an issue in the DSC Resource Kit:
 1. Fork the repository.
@@ -35,14 +32,27 @@ Here's the general process of fixing an issue in the DSC Resource Kit:
 9. Make sure your code does not contain merge conflicts.
 10. Address comments (if any).
 
-Build and Publishing
-============================
+### Build and Publishing
 
-AppVeyor is used to package up the resource and publish to the Powershell Gallery (on successful build from a newly pushed tag only).
+AppVeyor is used to package up the resource and publish to the PowerShell Gallery (on successful build from a newly pushed tag only).
 
 The AppVeyor scripts do the following:
 - Test the resources using 'xDSCResourceDesigner'
 - Verify best practises using 'PSScriptAnalyzer'
 - Update the version in the manifest file
-- Publish the module to the powershell gallery
-- Checkin updated manifest file to github
+- Publish the module to the PowerShell gallery
+- Check in updated manifest file to GitHub
+
+To build:
+
+1. Update `ModuleVersion` in `cChoco.psd1` - use `major.minor.patch.0`;
+2. Update `version` in `appveyor.yml` - use `major.minor.patch.{build}`;
+3. Merge development branch to master - `git checkout master`, `git merge development`;
+4. Tag master with new version - `git tag v<major.minor.patch>`;
+5. Push changes with tag `git push v<major.minor.patch>`
+
+## Known Issues / Troubleshooting
+
+### WS-Management - Exceeds the maximum envelope size allowed
+
+The maximum envelope size for WinRM is not sufficient for installing large packages. To increase the envelope size use `winrm set winrm/config @{MaxEnvelopeSizekb=”153600″}` - this exampe will increase it to 150MB.