Skip to content

Commit 04093cc

Browse files
authored
Update README.md
Better describe the steps needed to install the PowerShell module.
1 parent 6868d42 commit 04093cc

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ Get-ITGlueUsers
3131

3232
## Installation
3333

34-
One can manually download the Master branch and run the following PowerShell command:
34+
One can manually download the Master branch and place the "ITGlueAPI" folder into the (default) `C:\Program Files\WindowsPowerShell\Modules` folder.
3535

3636
```posh
37-
Import-Module .\ITGlueAPI.psd1
37+
Import-Module ITGlueAPI
3838
```
3939

4040

@@ -46,7 +46,7 @@ The first time you run this module, you will need to configure the base URI and
4646

4747
2. Run `Add-ITGlueAPIKey`. It will prompt you to enter your API key (please refer to IT Glue's documentation [here](https://api.itglue.com/developer/) for generating an API key).
4848

49-
3. [optional] If you would like the IT Glue module to remember your base uri and API key, you can run `Export-ITGlueModuleSettings`. This will create a config file at `Settings/config.psd1` that securely holds this information. Next time you run `Import-Module`, this configuration will automatically be loaded.
49+
3. [optional] If you would like the IT Glue module to remember your base uri and API key, you can run `Export-ITGlueModuleSettings`. This will create a config file at `%UserProfile%\ITGlueAPI` that securely holds this information. Next time you run `Import-Module`, this configuration will automatically be loaded.
5050

5151
:warning: Exporting module settings encrypts your API key in a format that can **only be unencrypted with your Windows account**. It makes use of PowerShell's `System.Security.SecureString` type, which uses reversible encrypted tied to your principle. This means that you cannot copy your configuration file to another computer or user account and expect it to work.
5252

@@ -99,4 +99,4 @@ Get-Help Get-ITGlueUsers
9999

100100
## Wiki :book:
101101

102-
For more information about using this module, as well as examples and advanced functionality, check out our [wiki](https://github.com/itglue/powershellwrapper/wiki/)!
102+
For more information about using this module, as well as examples and advanced functionality, check out our [wiki](https://github.com/itglue/powershellwrapper/wiki/)!

0 commit comments

Comments
 (0)