diff --git a/plugins/shrink-path/README.md b/plugins/shrink-path/README.md index 33dc3f8ae..71a242b2c 100644 --- a/plugins/shrink-path/README.md +++ b/plugins/shrink-path/README.md @@ -1,43 +1,50 @@ -# A plugin to shrink directory paths for brevity and pretty-printing +# shrink-path +A plugin to shrink directory paths for brevity and pretty-printing. + +To use it, add `shrink-path` to the plugins array in your zshrc file: + +```zsh +plugins=(... shrink-path) +``` ## Examples For this directory tree: ``` - /home/ - me/ - f o o/ # The prefix f is ambiguous between "f o o" and "f i g". - bar/ - quux/ - biz/ # The prefix b is ambiguous between bar and biz. - f i g/ - baz/ +/home/ + me/ + f o o/ # The prefix f is ambiguous between "f o o" and "f i g". + bar/ + quux/ + biz/ # The prefix b is ambiguous between bar and biz. + f i g/ + baz/ ``` here are the results of calling `shrink_path