Skip to content

Commit 71d8fa6

Browse files
committed
Add documentation
1 parent d484df2 commit 71d8fa6

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,20 @@ and triggers a inotify event.
77
## Purpose
88

99
Enables file watcher in a Docker container with a NFS mounted filesystem.
10+
11+
## Usage Example
12+
13+
# Magento 2 Profile
14+
./inotify-proxy -profile magento2 path/to/your/project
15+
16+
# Change frequence of file checks to 5s (default 2s)
17+
./inotify-proxy -sleep 5 path/to/your/project
18+
19+
## Supported Profiles
20+
21+
| Profile | Allowed file extensions |
22+
|----------------|-------------------------------------------------|
23+
| default | All extensions are allowed |
24+
| magento2 | .css .html .less .sass .js .php .phtml .ts .xml |
25+
| magento2-theme | .css .hs .less .sass .ts |
26+
| vue-storefront | .css .js .sass ts |

0 commit comments

Comments
 (0)