diff --git a/README.md b/README.md index 8828697..b1ae9ef 100644 --- a/README.md +++ b/README.md @@ -9,18 +9,21 @@ Zsh Diractions The goal of this plugin is *directory indexing*, map a short logical/mnemotechnical name to directory to quickly access them, or perform action in them. Thanks to **diraction** user can perform quick actions on its registered directory, `cd` into it, `ls` it, `git` it, running some command, or refering to them in any command with short variable to denote them. -### Example: +### Hello Diraction Suppose that I have a hypothetical `favdir` and `mydir` directories that i use a alot. Here are a simple scenario: you go in `favdir`, see what file there is then copy one in `mydir` using the variable. -Then checkying has been copied to the directory with `mydir ls`. +Then I check it has been copied to the directory with `mydir ls`, then go in one of mydir subdirectory ```sh -[~] >> favdir -[~_favdir] >> ls - some-file -[~_favdir] >> cp some-file $_mydir -[~_favdir] >> mydir ls - other-file some-file +[~] >> favdir # jumping in diraction folder +[~_favdir] >> ls + some-file +[~_favdir] >> cp some-file $_mydir # using mydir as a variable +[~_favdir] >> mydir ls # calling ls in mydir + other-file some-file +[~_favdir] >> mydir /sub # jumping in a sub directory of mydir +[~_mydir/sub] >> favdir - git status # run any command or alias + ? someuntrackfile ```