add readme

Signed-off-by: Mattias Andrée <maandree@operamail.com>

1 files changed, 30 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..2c887f9
--- /dev/null
+++ b/README
@@ -0,0 +1,30 @@
+Minimalitic `find` using breadth first crawling.
+
+The entire invocation syntax is:
+
+    bfind [--xdev] [--hardlinks] [--symlinks] DIRECTORY
+
+With --xdev crawling will not be restricted to
+one mount point.
+
+With --hardlinks bfind will be hardlink aware
+on directories.
+
+With --symlinks, bfind will visit directories
+symlinks points, and directories will never
+be revisited. Visited directories will be
+memorised by absolute path name.
+
+
+Short option alternatives:
+
+    -x --xdev
+    -h --hardlinks
+    -s --symlinks
+
+    Short options can be combined
+
+
+Each link will always start with DIRECTORY
+and always and with a /.
+