From 843f10bbb46a0b13362d0a3a21aa65f92f6c8ff8 Mon Sep 17 00:00:00 2001 From: Petri Asikainen Date: Wed, 9 Jun 2021 21:12:30 +0300 Subject: [PATCH] updated docs --- docs/about_SnipeitPS.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/about_SnipeitPS.md b/docs/about_SnipeitPS.md index 6745878..fcb3f69 100644 --- a/docs/about_SnipeitPS.md +++ b/docs/about_SnipeitPS.md @@ -8,11 +8,11 @@ Powershell API Wrapper for Snipe-it. Collection of tools that makes interacting with Snipe-it api more pleasant. # EXAMPLES -Prepare connection Snipe-It with +Prepare connection Snipe-It with: Set-SnipeitInfo -url https://your.site -apikey YourVeryLongApiKey.... -To search assets use +To search assets use: Get-SnipeitAsset -search needle @@ -21,23 +21,23 @@ set notes for every asset that have model_id 123. Get-SnipeitAsset -model_id 123 -all | Set-SnipeitAsset -# NOTE +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 -{{ Troubleshooting Placeholder - Warns users of bugs}} - -{{ Explains behavior that is likely to change with fixes }} +Check your api key and certificate on server first. # SEE ALSO -{{ See also placeholder }} -{{ You can also list related articles, blogs, and video URLs. }} +Report any issues to: +[GitHub project page](https://github.com/snazy2000/SnipeitPS/issues) # KEYWORDS -{{List alternate names or titles for this topic that readers might use.}} -- {{ Keyword Placeholder }} -- {{ Keyword Placeholder }} -- {{ Keyword Placeholder }} -- {{ Keyword Placeholder }} +- Snipe-It +- asset management