extended readme, basic tests

Author: iricigor

Docs/Get-GitModule.md

@@ -76,8 +76,7 @@ Accept wildcard characters: False
 ```
 
 ### CommonParameters
-This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
-For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
 
 ## INPUTS
 

Docs/Install-GitModule.md

@@ -92,8 +92,7 @@ Accept wildcard characters: False
 ```
 
 ### CommonParameters
-This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
-For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
 
 ## INPUTS
 

README.md

@@ -2,8 +2,37 @@
 
 Helps installing modules directly from GitHub or Azure DevOps
 
+## Prerequisites
+
+* **git** - it must be installed and available on path
+
 ## Installation
 
+### clone GitHub repository
+
+```PowerShell
+git clone https://github.com/iricigor/InstallGitModule
+Import-Module ./InstallGitModule/InstallGitModule.psd1
+```
+
+### from PowerShell gallery
+
+_(not yet available)_
+
+## Examples
+
+```PowerShell
+C:> Get-GitModule 'https://github.com/iricigor/FIFA2018' -Verbose
+
+C:> Install-GitModule 'https://github.com/iricigor/psaptgetupdate' | Select -Expand Name | Import-Module
+```
+
+## Commands
+
+### Get-GitModule
+
+### Install-GitModule
+
 ## Similar versions
 
-https://github.com/dfinke/InstallModuleFromGitHub/blob/master/InstallModuleFromGitHub.psm1
+[dfinke](https://github.com/dfinke)/[InstallModuleFromGitHub](https://github.com/dfinke/InstallModuleFromGitHub)

Tests/Get-GitModule.Tests.ps1

@@ -0,0 +1,77 @@
+#
+# This is a PowerShell Unit Test file.
+# You need a unit test framework such as Pester to run PowerShell Unit tests.
+# You can download Pester from http://go.microsoft.com/fwlink/?LinkID=534084
+#
+
+#
+# Import module
+#
+
+$ModuleName = 'InstallGitModule'
+$here = Split-Path -Parent $MyInvocation.MyCommand.Path # test folder
+$root = (get-item $here).Parent.FullName                # module root folder
+Import-Module (Join-Path $root "$ModuleName.psm1") -Force
+
+
+#
+# Fake test
+#
+
+Describe "Fake-Test" {
+    It "Should be fixed by developer" {
+        $true | Should -Be $true
+    }
+}
+
+
+#
+# Module should import six functions
+#
+
+
+Describe 'Proper Declarations' {
+
+    It 'Checks for existence of functions' {
+        @(Get-Command -Module $ModuleName -CommandType Function).Count | Should -Be 2 -Because 'We should have two functions defined'
+        Get-Command NonExistingCommand -ea 0 | Should -Be $Null
+        # cache management
+        Get-Command Get-GitModule -ea 0 | Should -Not -Be $Null
+        Get-Command Install-GitModule -ea 0 | Should -Not -Be $Null
+    }
+
+}
+
+
+Describe 'Proper Documentation' {
+
+	It 'Updates documentation and does git diff' {
+
+        # install PlatyPS
+        # Install-PackageProvider -Name NuGet -MinimumVersion 2.8.5.201 -Force
+        if (!(Get-Module platyPS -List -ea 0)) {Install-Module platyPS -Force -Scope CurrentUser}
+		Import-Module platyPS
+
+        # update documentation
+		Push-Location -Path $root
+        Update-MarkdownHelp -Path .\Docs
+        New-ExternalHelp -Path .\Docs -OutputPath .\en-US -Force
+
+        # test it
+        $diff = git diff .\Docs .\en-US
+        Pop-Location
+		$diff | Should -Be $null
+	}
+}
+
+
+Describe 'ScriptAnalyzer Tests' {
+    it 'Checks cmdlets and finds no errors' {
+        # Install PSScriptAnalyzer
+        if (!(Get-Module PSScriptAnalyzer -List -ea 0)) {Install-Module PSScriptAnalyzer -Force -Scope CurrentUser}
+        Import-Module PSScriptAnalyzer
+        # Check code
+        $SA = Invoke-ScriptAnalyzer -Path $root -Recurse
+        $SA | where Severity -eq 'Error' | Should -Be $null
+    }
+}