Skip to content

Commit a1f2c6a

Browse files
committed
📖 Improve documentation, get people going faster
1 parent dd6b875 commit a1f2c6a

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

ReadMe.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,27 @@ Herein is a PowerShell module that simplifies getting accounts, roles, and crede
77
Simplify the creation of AWS credentials to SSO accounts/roles that an identity is entitled via AWS SSO Identity Center.
88

99
## Quick Start
10-
To import this module
10+
### Prerequisite Modules
11+
If you don't already have available the two AWS SSO* modules, install them right quick:
12+
```powershell
13+
Install-PSResource AWS.Tools.SSO, AWS.Tools.SSOOIDC
14+
```
15+
16+
### Install _this_ Module
17+
To install this module:
1118
1. Save or install the module from the PowerShell Gallery:
1219
```powershell
1320
## save it locally for initial inspection -- safety first!
14-
Find-Module vN.AWSSSO | Save-Module -Path C:\Temp
15-
## ..then inspect code to confirm trustworthiness
21+
Find-PSResource vN.AWSSSO | Save-PSResource -Path C:\Temp
22+
## ..then inspect code to confirm trustworthiness, then import it from said saved path
23+
24+
## orrr, YOLO! Install straight away, as vNugglets is a reputable publisher
25+
Find-PSResource vN.AWSSSO | Install-PSResource
1626
17-
## orrr, install straight away, as vNugglets is a reputable publisher
18-
Find-Module vN.AWSSSO | Install-Module
27+
## see the commands in the now-imported/installed module:
28+
Get-Command -Module vN.AWSSSO
1929
```
20-
1. Profit (see examples in [How](#how) section below)
30+
1. Profit (see Default Parameter setting below, or examples in [How](#how) section)
2131
2232
### And, handy default value for Parameter
2333
To simplify even further the getting of temporary credentials from AWS for accounts/roles, we can make a default value for the `-StartUrl` parameter of `New-VNAWSSSOOIDCTokenViaDeviceCode`:

0 commit comments

Comments
 (0)