Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mivalsten authored Jan 29, 2019
1 parent 7c63386 commit 675054d
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,25 @@ Not all PowerShell Modules are published to the PowerShellGallery but are hosted
[Read the blog post](https://dfinke.github.io/2016/Quickly-Install-PowerShell-Modules-from-GitHub/)

## In Action
![image](https://github.com/dfinke/InstallModuleFromGitHub/blob/master/media/InstallFromGitHub.gif?raw=true)
![image](https://github.com/dfinke/InstallModuleFromGitHub/blob/master/media/InstallFromGitHub.gif?raw=true)

## Manual installation

Download zip/tar or `git clone` repo to your disk. Open powershell admin console, navigate to installation directory. Launch `InstallModule.ps1`. Module is installed to `C:\Program Files\WindowsPowerShell\Modules`

## Usage
Import module:
`Import-Module Install-ModuleFromGitHub`

To install module from [username]/[reponame], branch master:
`Install-ModuleFromGitHub -GitHubRepo [username]/[reponame]`

To chose different branch
`Install-ModuleFromGitHub -GitHubRepo [username]/[reponame] -branch testing`

Use `-destinationPath` to select different installation path.

Use `-SSOToken` to authenticate in private repositories. Default is anonymous authentication with access to public repositories.

Use `-moduleName` to change module name. Default is repository name.

0 comments on commit 675054d

Please sign in to comment.