Skip to content
This repository has been archived by the owner on Oct 21, 2022. It is now read-only.

Commit

Permalink
Add usage instructions for #4
Browse files Browse the repository at this point in the history
  • Loading branch information
cldwalker committed Jan 14, 2016
1 parent 8ffec36 commit ff66f78
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@

A simple JSHint integration that shows JSHint warnings directly in the editor.

## Usage

To run JSHint on a file, run the command `Run jshint on current editor`. By default this will display inline warnings.
This plugin has the following additional behaviors you can add to your user.behaviors:

* `:lt.plugins.jshint/gutter-hints` - Enable jshint warnings to show up as gutter hints that display warning on hover
* `:lt.plugins/jshint/jshint-options` - Configure JSHint with a map of [JSHint options](http://jshint.com/docs/options/)
* `:lt.plugins.jshint/jshint-globals` - Define a list of globals to ignore
* `:lt.plugins.jshint/on-save` - Run JSHint on file save
* `:lt.plugins.jshint/on-change` - Run JSHint on change

Use one of these behaviors with the right tag e.g. `[:editor.javascript :lt.plugins.jshint/on-change]`

## For Committers

This plugin depends on the JSHint package. To upgrade it npm install jshint@VERSION
This plugin depends on the JSHint package. To upgrade it `npm install jshint@VERSION` and ensure all behaviors work correctly.

0 comments on commit ff66f78

Please sign in to comment.