Skip to content

Commit 9438c8b

Browse files
authored
Logo (#4)
* first version * extended readme * smilies * tests screenshot, created img directory, md help * rearrange installations * update external help
1 parent db1be5c commit 9438c8b

5 files changed

Lines changed: 36 additions & 15 deletions

File tree

Docs/Get-GitModule.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ schema: 2.0.0
88
# Get-GitModule
99

1010
## SYNOPSIS
11-
{{Fill in the Synopsis}}
11+
12+
This cmdlet will check for existence of PowerShell module in given repository and return its version.
1213

1314
## SYNTAX
1415

@@ -17,7 +18,13 @@ Get-GitModule [-ProjectUri] <String[]> [-Branch <String>] [-KeepTempCopy] [<Comm
1718
```
1819

1920
## DESCRIPTION
20-
{{Fill in the Description}}
21+
22+
This cmdlet will check for existence of PowerShell module in given repository and return its version.
23+
You can also specify desired git branch.
24+
25+
Cmdlet requires `git` tool to work.
26+
It will download (`git clone`) specified repository to temporary repository and analyze it.
27+
By default, it will delete this temporary copy, but if needed, it can be kept.
2128

2229
## EXAMPLES
2330

README.md

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,61 @@
1-
# InstallGitModule
1+
<img align="right" width="203" height="294" src="img/InstallGitModule.logo.png">
22

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.
47

58
## Prerequisites
69

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).
811

912
## Installation
1013

14+
### from PowerShell gallery
15+
16+
:dash: _(not yet available)_
17+
1118
### clone GitHub repository
1219

1320
```PowerShell
1421
git clone https://github.com/iricigor/InstallGitModule
1522
Import-Module ./InstallGitModule/InstallGitModule.psd1
16-
```
23+
# and this is the last time you will be doing it like this
1724
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+
```
2128

2229
## Examples
2330

2431
```PowerShell
32+
# Check for module existence and its version
2533
C:> Get-GitModule 'https://github.com/iricigor/FIFA2018' -Verbose
2634
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
2837
```
2938

3039
## Commands
3140

3241
### Get-GitModule
3342

43+
Checks for module existence and returns its version. More info [here](/Docs/Get-GitModule.md).
44+
3445
### Install-GitModule
3546

47+
Installs PowerShell module to user's default install folder. More info [here](/Docs/Install-GitModule.md).
48+
3649
## Tests
3750

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)).
3952

4053
Windows build status [![Build Status](https://dev.azure.com/iiric/PS1/_apis/build/status/InstallGitModule%20-%20Win%20CI?branchName=master)](https://dev.azure.com/iiric/PS1/_build/latest?definitionId=16&branchName=master)
4154

4255
Linux build status [![Build Status](https://dev.azure.com/iiric/PS1/_apis/build/status/InstallGitModule%20-%20Linux%20CI?branchName=master)](https://dev.azure.com/iiric/PS1/_build/latest?definitionId=17&branchName=master)
4356

4457
_Click on images to see details about latest build runs._
4558

46-
## Similar versions
59+
## Similar PowerShell modules
4760

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)

en-US/InstallGitModule-help.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,12 @@
66
<command:verb>Get</command:verb>
77
<command:noun>GitModule</command:noun>
88
<maml:description>
9-
<maml:para>{{Fill in the Synopsis}}</maml:para>
9+
<maml:para>This cmdlet will check for existence of PowerShell module in given repository and return its version.</maml:para>
1010
</maml:description>
1111
</command:details>
1212
<maml:description>
13-
<maml:para>{{Fill in the Description}}</maml:para>
13+
<maml:para>This cmdlet will check for existence of PowerShell module in given repository and return its version. You can also specify desired git branch.</maml:para>
14+
<maml:para>Cmdlet requires `git` tool to work. It will download (`git clone`) specified repository to temporary repository and analyze it. By default, it will delete this temporary copy, but if needed, it can be kept.</maml:para>
1415
</maml:description>
1516
<command:syntax>
1617
<command:syntaxItem>

img/InstallGitModule.logo.png

41.2 KB
Loading

img/TestResults-AzureDevops.png

36.9 KB
Loading

0 commit comments

Comments
 (0)