Merge pull request #6 from hashicorp/jm.update-readme-polling

Update README regarding polling flag
hashicorp · Jul 13, 2020 · d23eaf1 · d23eaf1
2 parents 58d1b08 + f1ed170
commit d23eaf1
Showing 1 changed file with 6 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -46,11 +46,12 @@ You can [use globs](https://github.com/micromatch/picomatch), or pass in multipl
 
 ### Optional Flags
 
-| Option     | Shorthand | Example                      | Description                                                                    | Default         |
-| ---------- | --------- | ---------------------------- | ------------------------------------------------------------------------------ | --------------- |
-| `--root`   | `-r`      | `--root ./src`               | Path to Nextjs project                                                         | `process.cwd()` |
-| `--event`  | `-e`      | `--event add`                | Specific event to listen for (`add`, `addDir`, `change`, `unlink`, `unlinkDir` | `change`        |
-| `--script` | `-s`      | `--script ./scripts/sync.js` | Node script to be called on `event`. The file should export a function that accepts two arguments (`path`, `event`).             |
+| Option      | Shorthand | Example                      | Description                                                                                                                                                                                                                                     | Default         |
+| ----------- | --------- | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- |
+| `--root`    | `-r`      | `--root ./src`               | Path to Nextjs project                                                                                                                                                                                                                          | `process.cwd()` |
+| `--event`   | `-e`      | `--event add`                | Specific event to listen for (`add`, `addDir`, `change`, `unlink`, `unlinkDir`                                                                                                                                                                  | `change`        |
+| `--script`  | `-s`      | `--script ./scripts/sync.js` | Node script to be called on `event`. The file should export a function that accepts two arguments (`path`, `event`).                                                                                                                            |
+| `--polling` | `-p`      | `-p`                         | Whether to use `usePolling` option in chokidar, typically necessary to successfully watch files over a network; for details on performance impact and use cases see [chokidar documentation](https://github.com/paulmillr/chokidar#performance) | `false`         |
 
 ### The Magic Reload URL