Skip to content

Commit a9c7030

Browse files
committed
Add help content
1 parent 71d8fa6 commit a9c7030

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,24 @@ and triggers a inotify event.
88

99
Enables file watcher in a Docker container with a NFS mounted filesystem.
1010

11-
## Usage Example
11+
## Usage
12+
13+
Usage of ./inotify-proxy:
14+
-profile string
15+
Defines a special profile with extensions to look for. This speeds up the process. Available profiles are 'magento2-theme' (default "default")
16+
-sleep int
17+
Cycle time in seconds. Defines time to sleep after each filesystem walk. Default 2s (default 2)
18+
19+
### Examples
1220

1321
# Magento 2 Profile
1422
./inotify-proxy -profile magento2 path/to/your/project
1523

1624
# Change frequence of file checks to 5s (default 2s)
1725
./inotify-proxy -sleep 5 path/to/your/project
26+
27+
# Multiple pathes to watch ...
28+
./inotify-proxy project/path1 project/path2
1829

1930
## Supported Profiles
2031

0 commit comments

Comments
 (0)