diff --git a/triggers/git-coauthors/README.md b/triggers/git-coauthors/README.md index 10f45cb..4075305 100644 --- a/triggers/git-coauthors/README.md +++ b/triggers/git-coauthors/README.md @@ -1,3 +1,17 @@ # git-coauthors -Automatically add git coauthors when pairing on a call +Automatically add git coauthors when pairing on a call. + +Updates the file `$HOME/.gitmessage` with each participant as a coauthor. + +Ensure that `$HOME/.gitmessage` shows up in your commit template with the following command: + +```sh +$ git config --global commit.template $HOME/.gitmessage +``` + +For Windows you can use: + +```batch +> git config --global commit.template %USERPROFILE%\.gitmessage +``` diff --git a/triggers/git-coauthors/config.json b/triggers/git-coauthors/config.json index 98150cf..b984639 100644 --- a/triggers/git-coauthors/config.json +++ b/triggers/git-coauthors/config.json @@ -1,6 +1,6 @@ { "name": "Git Coauthors", "description": "Automatically add git coauthors when pairing on a call", - "platforms": ["macos", "linux"], + "platforms": ["macos", "linux", "windows"], "language": "ruby" }