From 238cc75579748f7f204e37dc859b02c5b125b9c0 Mon Sep 17 00:00:00 2001 From: Theis <112340858+Slug-Boi@users.noreply.github.com> Date: Mon, 4 Mar 2024 23:19:48 +0100 Subject: [PATCH] Update README.md updated syntax for author file --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 973b672..82a4053 100644 --- a/README.md +++ b/README.md @@ -35,10 +35,12 @@ $ cocommit users ``` # Syntax for the author file -The syntax for the author file can be found at the top of the template file included in the repo. It should look like this: +The syntax for the author file can be found at the top of the template file included in the repo. It should look like this (opt) is optional syntax: ``` -name_short|Name|Username|email +name_short|Name|Username|email (opt: |ex) ``` +opt explained: +ex -> excludes the given author for all and negation commands # Why? Writing co-authors onto commits can be pretty tedious so automating this process as a simple shell alias is a lot nicer