updating readme and notes in script

halldk · Jun 9, 2022 · 1c11ed2 · 1c11ed2
1 parent d1088ab
commit 1c11ed2
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 9 deletions.
diff --git a/Change-GitSignature.ps1 b/Change-GitSignature.ps1
@@ -1,11 +1,11 @@
 function Change-GitSignature {
     <#
     .Synopsis
-        Function to easily switch between GPG signatures for git
+        Function to easily switch between GPG signatures and emails for git
     .PARAMETER personal
-        Switch: Configures git to use your personal GPG key to sign commits
+        Switch: Configures git to use your personal GPG key and email to sign commits
     .PARAMETER work
-        Switch: Configures git to use your work GPG key to sign commits
+        Switch: Configures git to use your work GPG key and email to sign commits
     .NOTES
         Author: @Halldk (Dustin Hall)
         Uses a CSV file that has the key IDs of your GPG key, with a type either "work" or "personal" used to distinguish them.
@@ -26,10 +26,10 @@ function Change-GitSignature {
     param(
         [Parameter(Mandatory=$true, ParameterSetName="personal", HelpMessage="Switch: Configures git to use your personal or work GPG key to sign commits")]
             [switch]
-            $personal #Switch: Configures git to use your personal GPG key to sign commits
+            $personal #Switch: Configures git to use your personal GPG key and email to sign commits
         ,[Parameter(Mandatory=$true, ParameterSetName="work")]
             [switch]
-            $work #Switch: Configures git to use your work GPG key to sign commits
+            $work #Switch: Configures git to use your work GPG key and email to sign commits
     )
     $csv = Import-CSV "~\.gnupg\key_ids.csv"
     if($personal){

diff --git a/README.md b/README.md
@@ -1,14 +1,14 @@
 # Change-GitSignature.ps1
 - version
-    - 0.2
+    - 0.3
 - Synopsis
-    - Function to easily switch between GPG signatures for git
+    - Function to easily switch between GPG signatures and emails for git
 
 ## PARAMETERS 
 |   PARAMATER NAME    |  DESCRIPTION  |
 |   :---:   |   :---    |
-|   personal  |    Switch: Configures git to use your personal GPG key to sign commits  |
-|   work    |   Switch: Configures git to use your work GPG key to sign commits |
+|   personal  |    Switch: Configures git to use your personal GPG key and email to sign commits  |
+|   work    |   Switch: Configures git to use your work GPG key and email to sign commits |
 
 ## NOTES
 Author: @Halldk (Dustin Hall)