Merge pull request #186 from theaquamarine/deprecate

Warn of PowerShell 2.0 deprecation

posh-git.psm1

@@ -1,5 +1,16 @@
+param([switch]$NoVersionWarn = $false)
+
 if (Get-Module posh-git) { return }
 
+$psv = $PSVersionTable.PSVersion
+
+if ($psv.Major -lt 3 -and !$NoVersionWarn) {
+    Write-Warning ("posh-git support for PowerShell 2.0 is deprecated; you have version $($psv).`n" +
+    "To download version 3.0, please visit https://www.microsoft.com/en-us/download/details.aspx?id=34595`n" +
+    "For more information and to discuss this, please visit https://github.com/dahlbyk/posh-git/issues/163`n" +
+    "To suppress this warning, change your profile to include 'Import-Module posh-git -Args `$true'.")
+}
+
 Push-Location $psScriptRoot
 .\CheckVersion.ps1 > $null
 
@@ -23,8 +34,8 @@ Export-ModuleMember `
         'Invoke-NullCoalescing',
         'Write-GitStatus',
         'Write-Prompt',
-        'Get-GitStatus', 
-        'Enable-GitColors', 
+        'Get-GitStatus',
+        'Enable-GitColors',
         'Get-GitDirectory',
         'TabExpansion',
         'Get-AliasPattern',

readme.md

@@ -5,11 +5,11 @@ A set of PowerShell scripts which provide Git/PowerShell integration
 
 ### Prompt for Git repositories
    The prompt within Git repositories can show the current branch and the state of files (additions, modifications, deletions) within.
-   
+
 ### Tab completion
-   Provides tab completion for common commands when using git.  
+   Provides tab completion for common commands when using git.
    E.g. `git ch<tab>` --> `git checkout`
-   
+
 Usage
 -----
 
@@ -30,7 +30,7 @@ Install-Module posh-git
 Installing (manual)
 -------------------
 
-0. Verify you have PowerShell 2.0 or better with `$PSVersionTable.PSVersion`
+0. Verify you have PowerShell 2.0 or better with `$PSVersionTable.PSVersion`. PowerShell 3.0 is preferred as 2.0 support is deprecated.
 
 1. Verify execution of scripts is allowed with `Get-ExecutionPolicy` (should be `RemoteSigned` or `Unrestricted`). If scripts are not enabled, run PowerShell as Administrator and call `Set-ExecutionPolicy RemoteSigned -Scope CurrentUser -Confirm`.