diff --git a/README.md b/README.md index 5d48836..dbd200d 100644 --- a/README.md +++ b/README.md @@ -1,95 +1,28 @@ # PSSemVer -This module introduces a SemVer 2.0.0 compatible class for PowerShell. - -## Prerequisites - -No prerequisites. +PSSemVer is a PowerShell module that adds a SemVer-compatible class and helper functions. ## Installation -To install the module and class run the following command: +Install the module from the PowerShell Gallery: ```powershell -Install-Module -Name PSSemVer +Install-Module -Name Microsoft.PowerShell.PSResourceGet -Scope CurrentUser +Install-PSResource -Name PSSemVer Import-Module -Name PSSemVer ``` -## Usage - -Here is a list of example that are typical use cases for the module. -This section should provide a good overview of the module's capabilities. - -### Create a new SemVer object - -```powershell -$Version = New-PSSemVer -Version 1.0.0 -``` - -### Create a new SemVer object with prerelease and build metadata - -```powershell -$Version = New-PSSemVer -Version 1.0.0 -PreRelease 'alpha' -Build '2020-01-01' -``` - -### Create a new SemVer object from a string - -```powershell -$Version = New-PSSemVer -Version '1.0.0-alpha+2020-01-01' -``` - -### Compare two SemVer objects - -```powershell -$Version1 = New-PSSemVer -Version 1.0.0 -$Version2 = New-PSSemVer -Version 1.0.1 -$Version1 -lt $Version2 ->_ true -``` - -### Increment the major version - -```powershell -$Version = New-PSSemVer -Version 1.0.0 -$Version.BumpMajor() -``` - -### Increment the minor version - -```powershell -$Version = New-PSSemVer -Version 1.0.0 -$Version.BumpMinor() -``` - -### Increment the patch version +## Documentation -```powershell -$Version = New-PSSemVer -Version 1.0.0 -$Version.BumpPatch() -``` +Documentation is published at [psmodule.io/PSSemVer](https://psmodule.io/PSSemVer/). -### Set the prerelease +Use PowerShell help and command discovery for module details: ```powershell -$Version = New-PSSemVer -Version 1.0.0 -$Version.SetPreRelease('alpha') +Get-Command -Module PSSemVer +Get-Help ConvertTo-PSSemVer -Examples ``` ## 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. - -## Links - -- [Semantic Versioning 2.0.0](https://semver.org/) +Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements.