Merge pull request #149 from PetriAsi/update/readme

updated docs, adding about_snipeit

Author: PetriAsi

SnipeitPS/Public/Get-SnipeitManufacturer.ps1

@@ -1,38 +1,37 @@
 <#
-.SYNOPSIS
-# Gets a list of Snipe-it Manufacturers
+    .SYNOPSIS
+    # Gets a list of Snipe-it Manufacturers
 
-.PARAMETER search
-A text string to search the Manufactures data
+    .PARAMETER search
+    A text string to search the Manufactures data
 
-.PARAMETER id
-A id of specific Manufactuter
+    .PARAMETER id
+    A id of specific Manufactuter
 
-.PARAMETER limit
-Specify the number of results you wish to return. Defaults to 50. Defines batch size for -all
+    .PARAMETER limit
+    Specify the number of results you wish to return. Defaults to 50. Defines batch size for -all
 
-.PARAMETER offset
-Offset to use
+    .PARAMETER offset
+    Offset to use
 
-.PARAMETER all
-A return all results, works with -offset and other parameters
+    .PARAMETER all
+    A return all results, works with -offset and other parameters
 
-.PARAMETER url
-URL of Snipeit system, can be set using Set-SnipeitInfo command
+    .PARAMETER url
+    URL of Snipeit system, can be set using Set-SnipeitInfo command
 
-.PARAMETER apiKey
-Users API Key for Snipeit, can be set using Set-SnipeitInfo command
+    .PARAMETER apiKey
+    Users API Key for Snipeit, can be set using Set-SnipeitInfo command
 
-.EXAMPLE
-Get-SnipeitManufacturer -search HP
-Search all manufacturers for string HP
+    .EXAMPLE
+    Get-SnipeitManufacturer -search HP
+    Search all manufacturers for string HP
 
-.EXAMPLE
-Get-SnipeitManufacturer -id 3
-Returns manufacturer with id 3
+    .EXAMPLE
+    Get-SnipeitManufacturer -id 3
+    Returns manufacturer with id 3
 
 #>
-
 function Get-SnipeitManufacturer()
 {
     Param(

SnipeitPS/Public/Get-SnipeitSupplier.ps1

@@ -30,7 +30,6 @@ Get-SnipeitSupplier -search MySupplier
 Get-SnipeitSupplier -id 2
 
 #>
-
 function Get-SnipeitSupplier()
 {
     Param(

SnipeitPS/Public/Set-SnipeitUser.ps1

@@ -17,7 +17,7 @@
     .PARAMETER username
     Username for user
 
-    .PARAMETER active
+    .PARAMETER activated
     Can user log in to snipe-it?
 
     .PARAMETER notes

SnipeitPS/Public/Update-SnipeitAlias.ps1

@@ -10,12 +10,11 @@ Input string
 
 .EXAMPLE
 Get-Content [your-script.ps1] | Update-SnipeitAlias | Out-File [new-script-name.ps1]
+
 Replaces old command from file "your-script.ps1" and creates new script "new-script-name.ps1"
 After testing new file you can replace old file with new.
 
 #>
-
-
 function Update-SnipeitAlias()
 {
     [CmdletBinding(

docs/Set-SnipeitUser.md

@@ -34,7 +34,7 @@ Updates user with id 3
 ## PARAMETERS
 
 ### -activated
-{{ Fill activated Description }}
+Can user log in to snipe-it?
 
 ```yaml
 Type: Boolean

docs/SnipeitPS.md

@@ -135,5 +135,5 @@ Updates Model on Snipe-it asset system
 Creates a new user
 
 ### [Update-SnipeitAlias](Update-SnipeitAlias.md)
-{{ Fill in the Synopsis }}
+Replaces old SnipeitPS commands with new ones
 

docs/Update-SnipeitAlias.md

@@ -8,7 +8,7 @@ schema: 2.0.0
 # Update-SnipeitAlias
 
 ## SYNOPSIS
-{{ Fill in the Synopsis }}
+Replaces old SnipeitPS commands with new ones
 
 ## SYNTAX
 
@@ -17,29 +17,30 @@ Update-SnipeitAlias [-String] <String[]> [-WhatIf] [-Confirm] [<CommonParameters
 ```
 
 ## DESCRIPTION
-{{ Fill in the Description }}
+Replaces old SnipeitPS commands with new ones
 
 ## EXAMPLES
 
-### Example 1
-```powershell
-PS C:\> {{ Add example code here }}
+### EXAMPLE 1
+```
+Get-Content [your-script.ps1] | Update-SnipeitAlias | Out-File [new-script-name.ps1]
 ```
 
-{{ Add example description here }}
+Replaces old command from file "your-script.ps1" and creates new script "new-script-name.ps1"
+After testing new file you can replace old file with new.
 
 ## PARAMETERS
 
 ### -String
-{{ Fill String Description }}
+Input string
 
 ```yaml
 Type: String[]
 Parameter Sets: (All)
 Aliases:
 
 Required: True
-Position: 0
+Position: 1
 Default value: None
 Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
@@ -81,11 +82,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## INPUTS
 
-### System.String[]
-
 ## OUTPUTS
 
-### System.Object
 ## NOTES
 
 ## RELATED LINKS

docs/about_SnipeitPS.md

@@ -0,0 +1,43 @@
+# About SnipeitPS
+## about_SnipeitPS
+
+# SHORT DESCRIPTION
+Powershell API Wrapper for Snipe-it.
+
+# LONG DESCRIPTION
+Collection of tools that makes interacting with Snipe-it api more pleasant.
+
+# EXAMPLES
+Prepare connection Snipe-It with:
+
+Set-SnipeitInfo -url https://your.site -apikey YourVeryLongApiKey....
+
+To search assets use:
+
+Get-SnipeitAsset -search needle
+
+Piping get and new commands results to set commands is supported. Followirg will
+set notes for every asset that have model_id 123.
+
+Get-SnipeitAsset -model_id 123 -all | Set-SnipeitAsset
+
+You can get specific items with -id prameter like
+
+Get-SnipeitModel -id 123
+
+# NOTE
+Most of commands are using same parameters as in Snipe It api,
+but it's always good idea  check syntax with Get-Help
+
+# TROUBLESHOOTING NOTE
+Check your api key and certificate on server first.
+
+# SEE ALSO
+
+Report any issues to:
+[GitHub project page](https://github.com/snazy2000/SnipeitPS/issues)
+
+# KEYWORDS
+
+- Snipe-It
+- asset management