🌟 [Major]: ElvUI addon installation and update from PowerShell

README.md

@@ -1,53 +1,60 @@
-# {{ NAME }}
+# ElvUI
 
-{{ DESCRIPTION }}
+A PowerShell module for installing and updating the [ElvUI](https://www.tukui.org/elvui) addon
+for [World of Warcraft](https://worldofwarcraft.blizzard.com/).
 
 ## Prerequisites
 
-This uses the following external resources:
+- 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.
 
 ## Installation
 
-To install the module from the PowerShell Gallery, you can use the following command:
+To install the module from the PowerShell Gallery:
 
 ```powershell
-Install-PSResource -Name {{ NAME }}
-Import-Module -Name {{ NAME }}
+# 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
 
-Here is a list of example that are typical use cases for the module.
+### Update ElvUI to the latest version
 
-### Example 1: Greet an entity
+```powershell
+Update-ElvUI
+```
 
-Provide examples for typical commands that a user would like to do with the module.
+### Force reinstall even if already up to date
 
 ```powershell
-Greet-Entity -Name 'World'
-Hello, World!
+Update-ElvUI -Force
 ```
 
-### Example 2
+### Install ElvUI fresh
+
+```powershell
+Install-ElvUI
+```
 
-Provide examples for typical commands that a user would like to do with the module.
+### Target a different WoW installation or flavor
 
 ```powershell
-Import-Module -Name PSModuleTemplate
+Update-ElvUI -WoWPath 'D:\Games\World of Warcraft' -Flavor '_classic_'
 ```
 
 ### Find more examples
 
 To find more examples of how to use the module, please refer to the [examples](examples) folder.
 
-Alternatively, you can use the Get-Command -Module 'This module' to find more commands that are available in the module.
-To find examples of each of the commands you can use Get-Help -Examples 'CommandName'.
-
-## Documentation
-
-Link to further documentation if available, or describe where in the repository users can find more detailed documentation about
-the module's functions and features.
+You can also use `Get-Command -Module ElvUI` to list available commands,
+and `Get-Help -Examples <CommandName>` to see usage examples for each.
 
 ## Contributing
 
@@ -63,7 +70,3 @@ Please see the issues tab on this project and submit a new issue that matches yo
 
 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.
-
-## Acknowledgements
-
-Here is a list of people and projects that helped this project in some way.

examples/General.ps1

@@ -1,19 +1,19 @@
 <#
-  .SYNOPSIS
-    This is a general example of how to use the module.
+    .SYNOPSIS
+    Examples of how to use the ElvUI module.
 #>
 
 # Import the module
-Import-Module -Name 'PSModule'
+Import-Module -Name ElvUI
 
-# Define the path to the font file
-$FontFilePath = 'C:\Fonts\CodeNewRoman\CodeNewRomanNerdFontPropo-Regular.tff'
+# Update ElvUI to the latest version
+Update-ElvUI
 
-# Install the font
-Install-Font -Path $FontFilePath -Verbose
+# Force reinstall even if already up to date
+Update-ElvUI -Force
 
-# List installed fonts
-Get-Font -Name 'CodeNewRomanNerdFontPropo-Regular'
+# Install ElvUI fresh
+Install-ElvUI
 
-# Uninstall the font
-Get-Font -Name 'CodeNewRomanNerdFontPropo-Regular' | Uninstall-Font -Verbose
+# Target a specific WoW installation and game flavor
+Update-ElvUI -WoWPath 'D:\Games\World of Warcraft' -Flavor '_classic_'