|
1 | | -# InstallGitModule |
| 1 | +<img align="right" width="203" height="294" src="img/InstallGitModule.logo.png"> |
2 | 2 |
|
3 | | -Helps installing modules directly from GitHub or Azure DevOps |
| 3 | +# Install Git Module |
| 4 | + |
| 5 | +:bowtie: This PowerShell module will be help you to easily instal PowerShell modules directly from Azure DevOps (aka VSTS) or GitHub. |
| 6 | +All you need to know is a URL of the git repository and the module will take care of everything else. |
4 | 7 |
|
5 | 8 | ## Prerequisites |
6 | 9 |
|
7 | | -* **git** - it must be installed and available on path |
| 10 | +* :exclamation: **git** - Git must be installed and available on path. If you don't have it, you can get it for example from [git-scm.com](https://git-scm.com/downloads). |
8 | 11 |
|
9 | 12 | ## Installation |
10 | 13 |
|
| 14 | +### from PowerShell gallery |
| 15 | + |
| 16 | +:dash: _(not yet available)_ |
| 17 | + |
11 | 18 | ### clone GitHub repository |
12 | 19 |
|
13 | 20 | ```PowerShell |
14 | 21 | git clone https://github.com/iricigor/InstallGitModule |
15 | 22 | Import-Module ./InstallGitModule/InstallGitModule.psd1 |
16 | | -``` |
| 23 | +# and this is the last time you will be doing it like this |
17 | 24 |
|
18 | | -### from PowerShell gallery |
19 | | - |
20 | | -_(not yet available)_ |
| 25 | +# after you install this module you can do it like this |
| 26 | +Install-GitModule https://github.com/iricigor/InstallGitModule |
| 27 | +``` |
21 | 28 |
|
22 | 29 | ## Examples |
23 | 30 |
|
24 | 31 | ```PowerShell |
| 32 | +# Check for module existence and its version |
25 | 33 | C:> Get-GitModule 'https://github.com/iricigor/FIFA2018' -Verbose |
26 | 34 |
|
27 | | -C:> Install-GitModule 'https://github.com/iricigor/psaptgetupdate' -Force | Select -Expand Name | Import-Module |
| 35 | +# Download and import module in one line |
| 36 | +C:> (Install-GitModule 'https://github.com/iricigor/psaptgetupdate').Name | Import-Module |
28 | 37 | ``` |
29 | 38 |
|
30 | 39 | ## Commands |
31 | 40 |
|
32 | 41 | ### Get-GitModule |
33 | 42 |
|
| 43 | +Checks for module existence and returns its version. More info [here](/Docs/Get-GitModule.md). |
| 44 | + |
34 | 45 | ### Install-GitModule |
35 | 46 |
|
| 47 | +Installs PowerShell module to user's default install folder. More info [here](/Docs/Install-GitModule.md). |
| 48 | + |
36 | 49 | ## Tests |
37 | 50 |
|
38 | | -So far testing is very basic. |
| 51 | +:smirk: So far the module have very very basic testing, but it is doing that against two platforms - Linux and Windows. Tests results are available on Tests tab ([example here](/img/TestResults-AzureDevops.png)). |
39 | 52 |
|
40 | 53 | Windows build status [](https://dev.azure.com/iiric/PS1/_build/latest?definitionId=16&branchName=master) |
41 | 54 |
|
42 | 55 | Linux build status [](https://dev.azure.com/iiric/PS1/_build/latest?definitionId=17&branchName=master) |
43 | 56 |
|
44 | 57 | _Click on images to see details about latest build runs._ |
45 | 58 |
|
46 | | -## Similar versions |
| 59 | +## Similar PowerShell modules |
47 | 60 |
|
48 | | -[dfinke](https://github.com/dfinke)/[InstallModuleFromGitHub](https://github.com/dfinke/InstallModuleFromGitHub) |
| 61 | +:mega: [dfinke](https://github.com/dfinke)/[InstallModuleFromGitHub](https://github.com/dfinke/InstallModuleFromGitHub) |
0 commit comments