update readme

Signed-off-by: inhere <[email protected]>

Author: inhere

README.md

@@ -9,14 +9,53 @@ Some useful filesystem util for php
 - basic filesystem operation
 - file read/write operation
 - directory operation
-- file finder
+- file modify watcher
+- files finder
 
 ## Install
 
 ```bash
 composer require toolkit/fsutil
 ```
 
+## Usage
+
+### File Finder
+
+```php
+use Toolkit\FsUtil\FileFinder;
+
+$finder = FileFinder::create()
+    ->files()
+    ->name('*.php')
+    // ->ignoreVCS(false)
+    // ->ignoreDotFiles(false)
+    // ->exclude('tmp')
+    ->notPath('tmp')
+    ->inDir(dirname(__DIR__));
+
+foreach ($finder as $file) {
+    // var_dump($file);
+    echo "+ {$file->getPathname()}\n";
+}
+```
+
+### Modify Watcher
+
+```php
+use Toolkit\FsUtil\ModifyWatcher;
+
+$w  = new ModifyWatcher();
+$ret = $w
+    // ->setIdFile(__DIR__ . '/tmp/dir.id')
+    ->watch(dirname(__DIR__))
+    ->isChanged();
+
+// d41d8cd98f00b204e9800998ecf8427e
+// current file:  ae4464472e898ba0bba8dc7302b157c0
+var_dump($ret, $mw->getDirMd5(), $mw->getFileCounter());
+```
+
 ## License
 
 MIT

example/dir-watcher.php

@@ -12,8 +12,10 @@
 require dirname(__DIR__) . '/test/boot.php';
 
 $mw  = new ModifyWatcher();
-$ret = $mw// ->setIdFile(__DIR__ . '/tmp/dir.id')
-    ->watch(dirname(__DIR__))->isChanged();
+$ret = $mw
+    // ->setIdFile(__DIR__ . '/tmp/dir.id')
+    ->watch(dirname(__DIR__))
+    ->isChanged();
 
 // d41d8cd98f00b204e9800998ecf8427e
 // current file:  ae4464472e898ba0bba8dc7302b157c0

example/file-finder.php

@@ -13,13 +13,17 @@
 // var_dump(fnmatch('.*', ".gitkeep"));die;
 // var_dump(glob(__DIR__ . '/{t,T}ests', GLOB_BRACE | GLOB_ONLYDIR));
 
-$finder = FileFinder::create()->files()->name('*.php')// ->ignoreVCS(false)
+$finder = FileFinder::create()
+    ->files()
+    ->name('*.php')
+    // ->ignoreVCS(false)
     // ->ignoreDotFiles(false)
     // ->exclude('tmp')
-                    ->notPath('tmp')->inDir(dirname(__DIR__));
+    ->notPath('tmp')
+    ->inDir(dirname(__DIR__));
 
 foreach ($finder as $file) {
-    // var_dump($file);die;
+    // var_dump($file);
     echo "+ {$file->getPathname()}\n";
 }