From d14ae361a192650ca434fd0bdaaa2690b4f1d051 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 08:26:49 +0200 Subject: [PATCH 1/3] Standardize README landing page --- README.md | 61 ++++++++----------------------------------------------- 1 file changed, 8 insertions(+), 53 deletions(-) diff --git a/README.md b/README.md index 98104be..25b5e9b 100644 --- a/README.md +++ b/README.md @@ -1,72 +1,27 @@ # ElvUI -A PowerShell module for installing and updating the [ElvUI](https://www.tukui.org/elvui) addon -for [World of Warcraft](https://worldofwarcraft.blizzard.com/). - -## Prerequisites - -- Windows PowerShell 5.1 or PowerShell 7+ -- A World of Warcraft installation -- The [PSModule framework](https://github.com/PSModule/Process-PSModule) for building, testing and publishing the module. +ElvUI is a PowerShell module for working with ElvUI endpoints and updating the ElvUI addon. ## Installation -To install the module from the PowerShell Gallery: +Install the module from the PowerShell Gallery: ```powershell -# PowerShell 7.4+ (Install-PSResource is built-in) Install-PSResource -Name ElvUI Import-Module -Name ElvUI - -# Windows PowerShell 5.1 (use Install-Module instead) -Install-Module -Name ElvUI -Scope CurrentUser -Import-Module -Name ElvUI -``` - -## Usage - -### Update ElvUI to the latest version - -```powershell -Update-ElvUI -``` - -### Force reinstall even if already up to date - -```powershell -Update-ElvUI -Force ``` -### Install ElvUI fresh +## Documentation -```powershell -Install-ElvUI -``` +Documentation is published at [psmodule.io/ElvUI](https://psmodule.io/ElvUI/). -### Target a different WoW installation or flavor +Use PowerShell help and command discovery for module details: ```powershell -Update-ElvUI -WoWPath 'D:\Games\World of Warcraft' -Flavor '_classic_' +Get-Command -Module ElvUI +Get-Help -Examples ``` -### Find more examples - -To find more examples of how to use the module, please refer to the [examples](examples) folder. - -You can also use `Get-Command -Module ElvUI` to list available commands, -and `Get-Help -Examples ` to see usage examples for each. - ## Contributing -Coder or not, you can contribute to the project! We welcome all contributions. - -### For Users - -If you don't code, you still sit on valuable information that can make this project even better. If you experience that the -product does unexpected things, throw errors or is missing functionality, you can help by submitting bugs and feature requests. -Please see the issues tab on this project and submit a new issue that matches your needs. - -### For Developers - -If you do code, we'd love to have your contributions. Please read the [Contribution guidelines](CONTRIBUTING.md) for more information. -You can either help by picking up an existing issue or submit a new one if you have an idea for a new feature or improvement. +Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements. From cec7fc768cca74c6e9f8ddafe77e886d6802e8e8 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 10:31:36 +0200 Subject: [PATCH 2/3] Address Copilot README review --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 25b5e9b..e9952a7 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,17 @@ # ElvUI -ElvUI is a PowerShell module for working with ElvUI endpoints and updating the ElvUI addon. +ElvUI is a PowerShell module for working with the Tukui API and updating the ElvUI addon. ## Installation Install the module from the PowerShell Gallery: +```powershell +Install-Module -Name ElvUI +``` + +Or with PSResourceGet: + ```powershell Install-PSResource -Name ElvUI Import-Module -Name ElvUI From 85dd19cc5152c71500054ba2d1b5b159bf369197 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 10:57:47 +0200 Subject: [PATCH 3/3] Address Copilot README review --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e9952a7..2e5fe6c 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ Install the module from the PowerShell Gallery: ```powershell Install-Module -Name ElvUI +Import-Module -Name ElvUI ``` Or with PSResourceGet: @@ -25,7 +26,7 @@ Use PowerShell help and command discovery for module details: ```powershell Get-Command -Module ElvUI -Get-Help -Examples +Get-Help Install-ElvUI -Examples ``` ## Contributing