diff --git a/README.md b/README.md index be6dddd..8822264 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,25 @@ Ensure that you test operations from this module that make changes to your infra well tested on a pre-production copy before you apply to any production resource! I won't be held responsible if you blow up your production stacks. -# Installation +# What this is +A module containing a collection of PowerShell scripts I've created to ease various tasks. + +See the [Command Docs](https://github.com/fireflycons/aws-toolbox/tree/master/docs/en-US/aws-toolbox.md) + +# How to Install + +The module is published on the PowerShell Gallery and can be installed by following the instructions there. + +## Windows PowerShell +![PowerShell Gallery](https://img.shields.io/powershellgallery/v/aws-toolbox) -This module is published in the PowerShell Gallery for [Windows PowerShell](https://www.powershellgallery.com/packages?q=aws-toolbox) and [PowerShell Core/Linux](https://www.powershellgallery.com/packages?q=aws-toolbox.netcore) +https://www.powershellgallery.com/packages/aws-toolbox + + +## PowerShell Core (Linux) +![PowerShell Gallery](https://img.shields.io/powershellgallery/v/aws-toolbox.netcore) + +https://www.powershellgallery.com/packages/aws-toolbox.netcore Some tools in this collection can provide visual difference comparisons on various things, currenrly CloudFormation templates and stack resource drift. You should configure a diff viewer using `Set-ATConfigurationItem` first. @@ -19,7 +35,3 @@ and stack resource drift. You should configure a diff viewer using `Set-ATConfig Currently supported diff viewers are git, WinMerge and Visual Studio Code. If you have a diff viewer you would like to see supported then raise an issue in GitHub. -# What this is -A module containing a collection of PowerShell scripts I've created to ease various tasks. - -See the [Command Docs](https://github.com/fireflycons/aws-toolbox/tree/master/docs/en-US/aws-toolbox.md)