Skip to content

Commit

Permalink
Issue #7: Add the description for brute_mode into README.
Browse files Browse the repository at this point in the history
  • Loading branch information
gh640 committed Sep 10, 2018
1 parent cf3fd5c commit 0b99270
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,18 @@ You can run a command with the command palette (ctrl/cmd + shift + p).

Or, you can use the context menu item `Show definition` to open the definition popup.

### Brute mode

Additionally, you can use a mode named `brute_mode` with which the package tries to generate a popup aggressively every time when you move your mouse cursor. With the mode enabled, you don't need to call the command.

Of course, the mode is disabled by default. You can enable it through the package settings:

```json
{
"brute_mode": true
}
```

## License

Licensed under the MIT license.

0 comments on commit 0b99270

Please sign in to comment.