From b3f3e518196428f144fd7f30144074e7223af380 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A1bio=20Ferreira?= Date: Sun, 27 Oct 2024 11:49:58 +0000 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20new=20add=20and=20?= =?UTF-8?q?list=20commands?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8d1debb..6cf1708 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,9 @@ npm add --save-dev tripauthor yarn add --dev tripauthor ``` -## Usage +## Configuration -### Global configuration +### Global hooks **By doing this, all repositories will use the global hooks even if they have git hooks configured.** ```bash @@ -34,13 +34,26 @@ chmod a+x ~/githooks/* ### Husky ```bash -echo "yarn tripauthor -f $1" > .husky/commit-msg - +echo "exec < /dev/tty && yarn tripauthor -f $1" > .husky/commit-msg chmod a+x .husky/commit-msg ``` -## Add more coauthors +## Usage + +### Set up new co-author + +```bash +npx tripauthor add + +# alias +npx tripauthor a +``` + +### List configured co-authors ```bash -echo "name " >> ~/.git_coauthors +npx tripauthor list + +# alias +npx tripauthor l ``` \ No newline at end of file