Add usage instructions to README

palantir · Jun 16, 2016 · d0c1364 · d0c1364
1 parent be01b00
commit d0c1364
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -7,6 +7,23 @@ tslint-react
 
 Lint rules related to React & JSX for [TSLint](https://github.com/palantir/tslint/).
 
+### Usage
+
+Sample configuration where `tslint.json` lives adjacent to your `node_modules` folder:
+
+```js
+{
+  "extends": "tslint:latest",
+  "rulesDirectory": [
+    "./node_modules/tslint-react/rules"
+  ],
+  "rules": {
+    // enable tslint-react rules here
+    "jsx-no-lambda": true
+  }
+}
+```
+
 ### Rules
 
 - `jsx-no-lambda`