diff --git a/plugins/pathfmt/README.md b/plugins/pathfmt/README.md index e69de29bb..b56e676c3 100644 --- a/plugins/pathfmt/README.md +++ b/plugins/pathfmt/README.md @@ -0,0 +1,30 @@ +## Pathfmt plugin + +This plugin adds current path information (ex: `~/Downloads/images/...`) into your terminal. + +To use it, add `pathfmt` to the plugins array of your zshrc file: +``` +plugins=(... pathfmt ...) +``` + +### Configuration (required) +Add these into your zshrc file: +``` +#options = absolute/user/host +PATHFMT_MODE="user" +RPROMPT='$(path_format)' +``` + +
+ +### Things to Note: +`PATHFMT_MODE` has three modes: +``` +1. absolute - full path (from /). +2. user - path from $USER/ +3. host - user@machine/ +``` + + +Requires [`inetutils`]([url](https://launchpad.net/ubuntu/+source/inetutils)) for the host mode +> may show: user@unknown when not found & in host mode