Skip to content

Commit c7420ba

Browse files
committed
Update README
1 parent 46ae67c commit c7420ba

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@ You'll need Sublime Text build `3070` or greater (tooltip support). Neither Flow
88
## Usage
99
Install with Package Control!
1010

11-
FlowIDE features only activate on files with the `// @flow` declaration.
11+
FlowIDE features only activate on files with the `// @flow` or `/* @flow */ declarations. It automatically determines the root directory and `.flowconfig` of the file you're currently working on.
12+
13+
FlowIDE works out-of-the-box if the `flow` binary is in your `PATH`. To fit your needs, you can change the following settings:
14+
- `flow_path` (string): the path to your `flow` binary.
15+
- `use_npm_flow` (boolean): if true, uses the binary from the npm `flow-bin` package in the `node_modules` of your current file's root directory. Using `flow-bin`'s binary will slow down editing features because it is wrapped in a Node script and starts an interpreter on each run.
1216

1317
### Diagnostics and Autocomplete
1418
Just works! Autocomplete generates snippets with parameter names when pressing `Enter`.

0 commit comments

Comments
 (0)