From 1c11ed258bc9d48395a25bb728724974dddf5f6e Mon Sep 17 00:00:00 2001 From: Dustin Hall Date: Thu, 9 Jun 2022 13:04:49 -0600 Subject: [PATCH] updating readme and notes in script --- Change-GitSignature.ps1 | 10 +++++----- README.md | 8 ++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/Change-GitSignature.ps1 b/Change-GitSignature.ps1 index 5fed961..e7eede2 100644 --- 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 index c4535af..2a8bb9b 100644 --- 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)