From e99758fe0e24c5b00c9249e5a6bae3cd5f5c0d4e Mon Sep 17 00:00:00 2001
From: Benjamin Renard <brenard@easter-eggs.com>
Date: Mon, 12 Dec 2022 19:47:47 +0100
Subject: [PATCH] Update usage in README.md

---
 README.md | 37 +++++++++++++++++++++++++++++++++----
 1 file changed, 33 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index c1ce852..914bc3a 100644
--- a/README.md
+++ b/README.md
@@ -32,9 +32,13 @@ chmod +x /usr/local/bin/gitdch
 
 # Usage
 ```
-usage: gitdch [-h] [-d] [-v] [-w] [-l LOGFILE] [-q] [-p GIT_PATH] [-o OUTPUT] [-n PACKAGE_NAME] [-V VERSION] [--version-suffix VERSION_SUFFIX] [-c CODE_NAME] [-u URGENCY]
+usage: gitdch [-h] [-d] [-v] [-w] [-l LOGFILE] [-q] [-p GIT_PATH] [-o OUTPUT] [-A]
+              [-n PACKAGE_NAME] [-V VERSION] [--version-suffix VERSION_SUFFIX]
+              [-c CODE_NAME] [-u URGENCY] [-N MAINTAINER_NAME] [-E MAINTAINER_EMAIL]
+              [-R RELEASE_NOTES] [--revision REVISION] [-C CLEAN_TAGS_REGEX]
+              [-x EXCLUDE]
 
-Generate Debian package changelog from git
+Generate Debian package changelog from git (version: 0.0)
 
 optional arguments:
   -h, --help            show this help message and exit
@@ -43,21 +47,46 @@ optional arguments:
   -w, --warning         Show warning messages
   -l LOGFILE, --log-file LOGFILE
                         Log file path
-  -q, --quiet           Quiet mode: do not log on console (only if log file is provided)
+  -q, --quiet           Quiet mode: do not log on console (only if log file is
+                        provided)
   -p GIT_PATH, --path GIT_PATH
                         Git repository path (default: ./)
   -o OUTPUT, --output OUTPUT
                         Generated Debian changelog output path (default: stdout)
+  -A, --append          Append mode: if the output changelog file already exists,
+                        append generated changelog lines at the begining of the file
+                        (optional, default: overwriting the file)
   -n PACKAGE_NAME, --package-name PACKAGE_NAME
                         Package name
   -V VERSION, --version VERSION
-                        Currrent version (default: autodetected using git describe --always --tags)
+                        Currrent version (default: autodetected using git describe
+                        --always --tags)
   --version-suffix VERSION_SUFFIX
                         Suffix for autodetected version
   -c CODE_NAME, --code-name CODE_NAME
                         Debian code name (default: unstable)
   -u URGENCY, --urgency URGENCY
                         Package urgency (default: medium)
+  -N MAINTAINER_NAME, --maintainer-name MAINTAINER_NAME
+                        Maintainer name (default: last commit author name)
+  -E MAINTAINER_EMAIL, --maintainer-email MAINTAINER_EMAIL
+                        Maintainer email (default: last commit author email)
+  -R RELEASE_NOTES, --release-notes RELEASE_NOTES
+                        Specify an optional Markdown release notes output path
+  --revision REVISION   Specify the revision to use to generate the changelog (see
+                        git-rev-parse for viable options, optional, default:
+                        generate the changelog with all commits of the current
+                        branch)
+  -C CLEAN_TAGS_REGEX, --clean-tags-regex CLEAN_TAGS_REGEX
+                        Clean tags regex: you could specify regex to clean tag names
+                        when computing package versions. For instance, to drop a
+                        "-eeXXX" suffix of tag names, specify -C "\-ee[0-9]{3}$"
+                        (optional, multiple regex allowed)
+  -x EXCLUDE, --exclude EXCLUDE
+                        Commit exclusion regex: you could specify regex to exclude
+                        some commits from generated changelog entries. For instance,
+                        to exclude commits with message starting with "CI: ",
+                        specify -x "^CI: " (optional, multiple regex allowed)
 ```
 
 ## Copyright