From 60a0a90d11074af5b790bb5b32010047f50e5a1b Mon Sep 17 00:00:00 2001 From: Max Claus Nunes Date: Sat, 19 Jan 2019 17:43:21 -0200 Subject: [PATCH] Add notes about the watch method used in Gaper --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e6fa315..8795e20 100644 --- a/README.md +++ b/README.md @@ -64,9 +64,9 @@ GLOBAL OPTIONS: ### Watch and Ignore paths -For those options gaper supports static paths (e.g. `build/`, `seed.go`) or glob paths (e.g. `migrations/**/up.go`, `*_test.go`). +For those options Gaper supports static paths (e.g. `build/`, `seed.go`) or glob paths (e.g. `migrations/**/up.go`, `*_test.go`). -On using a path to a directory please add a `/` at the end (e.g. `build/`) to make sure gaper won't include other matches that starts with that same value (e.g. `build/`, `build_settings.go`). +On using a path to a directory please add a `/` at the end (e.g. `build/`) to make sure Gaper won't include other matches that starts with that same value (e.g. `build/`, `build_settings.go`). ### Default ignore settings @@ -78,6 +78,10 @@ Since in most projects there is no need to watch changes of: Gaper by default ignores those cases already. Although, if you need Gaper to watch those files anyway it is possible to disable this setting with `--disable-default-ignore` argument. +### Watch method + +Currently Gaper uses polling to watch file changes. We have plans to [support fs events](https://github.com/maxcnunes/gaper/issues/12) though in a near future. + ### Examples Using all defaults provided by Gaper: