Explain how identity matching works in README

prydonius · Apr 30, 2015 · c99aa63 · c99aa63
1 parent e218143
commit c99aa63
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -39,10 +39,15 @@ karn looks for a YAML configuration file in your home directory, `~/.karn.yml`.
 A sample configuration looks like this:
 ```
 ---
-/Fun:
+~/Fun:
   name: Adnan Abdulhussein
   email: [email protected]
-/Projects:
+~/Fun/karn:
+  name: Sisterhood of Karn
+  email: [email protected]
+/Work:
   name: Adnan A
   email: [email protected]
 ```
+
+In a given repo, karn will try to match with the deepest configured directory. For the configuration above, any repo under the `~/Fun` directory will match the first identity, with the exception of `~/Fun/karn` which matches the second identity. If an identity isn't found, the repo is left untouched.