From 09bb508a55046d3baa5a90683b9a7e321fd6c882 Mon Sep 17 00:00:00 2001 From: Muhammad Talal Anwar Date: Tue, 21 Jun 2022 06:45:32 +0200 Subject: [PATCH] README: update usage options --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index bdda364..008f2b2 100644 --- a/README.md +++ b/README.md @@ -16,12 +16,14 @@ addlicense requires go 1.16 or later. addlicense [flags] pattern [pattern ...] - -c copyright holder (defaults to "Google LLC") - -f custom license file (no default) - -l license type: apache, bsd, mit, mpl (defaults to "apache") - -y year (defaults to current year) - -check check only mode: verify presence of license headers and exit with non-zero code if missing + -c copyright holder (default "Google LLC") + -check check only mode: verify presence of license headers and exit with non-zero code if missing + -f license file -ignore file patterns to ignore, for example: -ignore **/*.go -ignore vendor/** + -l license type: apache, bsd, mit, mpl (default "apache") + -s Include SPDX identifier in license header. Set -s=only to only include SPDX identifier. + -v verbose mode: print the name of the files that are modified + -y copyright year(s) (default "2022") The pattern argument can be provided multiple times, and may also refer to single files. Directories are processed recursively.