diff --git a/README.md b/README.md index b365a91..ea64228 100644 --- a/README.md +++ b/README.md @@ -1 +1,32 @@ -[![Build status](https://ci.appveyor.com/api/projects/status/dvuw4ggx543nx3h7?svg=true)](https://ci.appveyor.com/project/snazy2000/snipeitps) \ No newline at end of file +[![GitHub release](https://img.shields.io/github/release/snazy2000/SnipeitPS.svg)](https://github.com/snazy2000/SnipeitPS/releases/latest) [![Build status] +[![Build status](https://ci.appveyor.com/api/projects/status/dvuw4ggx543nx3h7?svg=true)](https://ci.appveyor.com/project/snazy2000/snipeitps) +(https://img.shields.io/powershellgallery/dt/snipeitps.svg)](https://www.powershellgallery.com/packages/snipeitps) ![License](https://img.shields.io/badge/license-MIT-blue.svg) + +--- + +## Instructions + +### Installation + +Install SnipeitPS from the [PowerShell Gallery]! `Install-Module` requires PowerShellGet (included in PS v5, or download for v3/v4 via the gallery link) + +```powershell +# One time only install: (requires an admin PowerShell window) +Install-Module SnipeitPS + +# Check for updates occasionally: +Update-Module SnipeitPS + +# To use each session: +Import-Module SnipeitPS +Set-Info -URL 'https://asset.example.com' -apiKey 'tokenKey' +``` + +### Usage + +```powershell +# Review the help at any time! +Get-Help about_SnipeitPS +Get-Command -Module SnipeitPS +Get-Help Get-Asset -Full # or any other command +```