From 675054d227ab0537d0e641453b8fc8a2f052a313 Mon Sep 17 00:00:00 2001 From: mivalsten Date: Tue, 29 Jan 2019 08:26:01 +0100 Subject: [PATCH] Update README.md --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c961b6c..360dca1 100644 --- a/README.md +++ b/README.md @@ -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) \ No newline at end of file +![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. +