From 6c3d2501f2b507143df0b3159aa576b1eca56dcf Mon Sep 17 00:00:00 2001 From: Will Norris Date: Wed, 27 Jul 2022 12:16:22 -0700 Subject: [PATCH] docs: provide simple example in README --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fdb72ed..bdda364 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,12 @@ addlicense requires go 1.16 or later. -ignore file patterns to ignore, for example: -ignore **/*.go -ignore vendor/** The pattern argument can be provided multiple times, and may also refer -to single files. +to single files. Directories are processed recursively. + +For example, to run addlicense across everything in the current directory and +all subdirectories: + + addlicense . The `-ignore` flag can use any pattern [supported by doublestar](https://github.com/bmatcuk/doublestar#patterns).