improve docs

fixes #34
sindresorhus · Jun 4, 2015 · 002052a · 002052a
1 parent 726daee
commit 002052a
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 6 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -7,7 +7,7 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[package.json]
+[{package.json,*.yml}]
 indent_style = space
 indent_size = 2
 

diff --git a/.jshintrc b/.jshintrc
@@ -2,7 +2,6 @@
 	"node": true,
 	"esnext": true,
 	"bitwise": true,
-	"camelcase": true,
 	"curly": true,
 	"immed": true,
 	"newcap": true,

diff --git a/package.json b/package.json
@@ -7,7 +7,7 @@
   "author": {
     "name": "Sindre Sorhus",
     "email": "sindresorhus@gmail.com",
-    "url": "http://sindresorhus.com"
+    "url": "sindresorhus.com"
   },
   "engines": {
     "node": ">=0.10.0"

diff --git a/readme.md b/readme.md
@@ -7,7 +7,7 @@
 
 ## Install
 
-```sh
+```
 $ npm install --save-dev gulp-react
 ```
 
@@ -28,9 +28,9 @@ gulp.task('default', function () {
 
 ## API
 
-### react(options)
+### react([options])
 
-Options are passed to react-tools' [`transform` method](https://github.com/facebook/react/tree/master/npm-react-tools#transforminputstring-options).
+See the `react-tools` [options](https://github.com/facebook/react/tree/master/npm-react-tools#transforminputstring-options), except for `sourceMap` and `sourceFilename`, which are handled for you.
 
 
 ## Source Maps