Release 0.42

[chaz/git-codeowners] / README

diff --git a/README b/README
index a5e5712b2790ec9ac9530476265e44cfb468ec85..98bbc5b1692973b64e2f6f65a76fc27138632b22 100644 (file)
--- a/README
+++ b/README
@@ -4,13 +4,15 @@ NAME
 
 VERSION
 
 
 VERSION
 

-    version 0.41
+    version 0.42

 
 SYNOPSIS
 
         git-codeowners [--version|--help|--manual]
     
 
 SYNOPSIS
 
         git-codeowners [--version|--help|--manual]
     

-        git-codeowners [show] [--format FORMAT] [--[no-]project] [PATH...]
+        git-codeowners [show] [--format FORMAT] [--owner OWNER]...
+                       [--pattern PATTERN]... [--[no-]patterns]
+                       [--project PROJECT]... [--[no-]projects] [PATH...]

     
         git-codeowners owners [--format FORMAT] [--pattern PATTERN]
     
     
         git-codeowners owners [--format FORMAT] [--pattern PATTERN]
     


@@ -100,18 +102,35 @@ COMMANDS
 
  show
 
 
  show
 

-        git-codeowners [show] [--format FORMAT] [--[no-]project] [PATH...]
+        git-codeowners [show] [--format FORMAT] [--owner OWNER]...
+                       [--pattern PATTERN]... [--[no-]patterns]
+                       [--project PROJECT]... [--[no-]projects] [PATH...]

 
     Show owners of one or more files in a repo.
 
 
     Show owners of one or more files in a repo.
 

+    If --owner, --project, --pattern are set, only show files with matching
+    criteria. These can be repeated.
+
+    Use --patterns to also show the matching pattern associated with each
+    file.
+
+    By default the output might show associated projects if the CODEOWNERS
+    file defines them. You can control this by explicitly using --projects
+    or --no-projects to always show or always hide defined projects,
+    respectively.
+

  owners
 
         git-codeowners owners [--format FORMAT] [--pattern PATTERN]
 
  owners
 
         git-codeowners owners [--format FORMAT] [--pattern PATTERN]
 

+    List all owners defined in the CODEOWNERS file.
+

  patterns
 
         git-codeowners patterns [--format FORMAT] [--owner OWNER]
 
  patterns
 
         git-codeowners patterns [--format FORMAT] [--owner OWNER]
 

+    List all patterns defined in the CODEOWNERS file.
+

  create
 
         git-codeowners create [REPO_DIRPATH|CODEOWNERS_FILEPATH]
  create
 
         git-codeowners create [REPO_DIRPATH|CODEOWNERS_FILEPATH]


@@ -144,7 +163,7 @@ FORMAT
 
       * FORMAT - Custom format (see below)
 
 
       * FORMAT - Custom format (see below)
 

- Custom
+ Format string

 
     You can specify a custom format using printf-like format sequences.
     These are the items that can be substituted:
 
     You can specify a custom format using printf-like format sequences.
     These are the items that can be substituted:


@@ -177,7 +196,7 @@ FORMAT
 
       * nocolor - Do not colorize replacement string.
 
 
       * nocolor - Do not colorize replacement string.
 

- Table
+ Format table

 
     Table formatting can be done by one of several different modules, each
     with its own features and bugs. The default module is
 
     Table formatting can be done by one of several different modules, each
     with its own features and bugs. The default module is


@@ -188,6 +207,10 @@ FORMAT
 
     The list of available modules is at "@BACKENDS" in Text::Table::Any.
 
 
     The list of available modules is at "@BACKENDS" in Text::Table::Any.
 

+CAVEATS
+
+      * Some commands require git (at least version 1.8.5).
+

 BUGS
 
     Please report any bugs or feature requests on the bugtracker website
 BUGS
 
     Please report any bugs or feature requests on the bugtracker website