Add documentation to README

jibarra · jibarra · commit b7e09608ee4a · 2025-01-29T11:02:16.000-07:00
diff --git a/README.md b/README.md
@@ -164,6 +164,8 @@ bin/codeownership for_team 'My Team' > tmp/ownership_report.md
 
 A `CODEOWNERS` file defines who owns specific files or paths in a repository. When you run `bin/codeownership validate`, a `.github/CODEOWNERS` file will automatically be generated and updated.
 
+If the `CODEOWNERS_PATH` environment variable is set, codeowners will use that path to generate the `CODEOWNERS` file. For example, `CODEOWNERS=docs` will generate `docs/CODEOWNERS`.
+
 ## Proper Configuration & Validation
 
 CodeOwnership comes with a validation function to ensure the following things are true:
