guide to command

README.md

@@ -1,5 +1,33 @@
-# Nerd tree
+# Visual Find
+
+**vfind** is a tool written in python based on *nerd_tree*.<br />
+Its purpose (and base idea) is to blend the unix command *find* with the *tree* command.<br />
+You can search in a particular subtree for files or folders that match a regular expression and other criteria, the results will be shown graphically in a tree (in a similar way that the tree command does).<br />
+
+## Installation on your system
+
+In my opinion the better solution is:<br />
+1. Clone the repository in your home folder
+2. Go to your home folder and make a symbolic link to the command, in your ~/bin folder
+```
+  cd ~/nerd_tree
+  ln -s ~/nerd_tree/vfind.py ~/bin/vfind
+```
+
+## How to use
+
+**vfind** has 2 mandatory arguments, the *path* of subtree from which to begin the search and the *search* pattern (a regexp)
+
+```
+vfind ~/nerd_tree/ "(.*)rem(.*)"
+```
+
+all items matching the pattern are show in the result tree.<br />
+The folder matching the pattern are show with information about the total number of files and the size of the subtree.
+If you want to show the subtree expanded you can use the flag **-s**
+
+```
+vfind ~/nerd_tree/ "(.*)rem(.*)" -s
+```
+
 
-An ugly version of the unix-like tree command and a visual version of find command that shows the results found in a visual tree.
-All written in python language.
-Branch is unstable and under development