diff --git a/README.md b/README.md index 7bde73c..fae80a8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,27 @@ -# Demo +# WoW -Demo repository for a PSModule +WoW is a PowerShell module containing utilities for World of Warcraft. + +## Installation + +Install the module from the PowerShell Gallery: + +```powershell +Install-PSResource -Name WoW +Import-Module -Name WoW +``` + +## Documentation + +Documentation is published at [psmodule.io/WoW](https://psmodule.io/WoW/). + +Use PowerShell help and command discovery for module details: + +```powershell +Get-Command -Module WoW +Get-Help Get-WoWAccount -Examples +``` + +## Contributing + +Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements.