[doc] update documentation

README.md

@@ -1,13 +1,14 @@
 # ESLint config Namics
 
 [![Build Status](https://img.shields.io/travis/namics/eslint-config-namics/master.svg)](https://travis-ci.org/namics/eslint-config-namics)
+[![Build Status](https://ci.appveyor.com/api/projects/status/sroqr91h6gjecoqi/branch/master?svg=true)](https://ci.appveyor.com/project/smollweide/eslint-config-namics/branch/master)
 [![Dependencies](https://img.shields.io/david/namics/eslint-config-namics/master.svg)](https://david-dm.org/namics/eslint-config-namics)
 [![npm](https://img.shields.io/npm/v/@namics/eslint-config.svg)](https://www.npmjs.com/package/@namics/eslint-config)
 [![Codestyle](https://img.shields.io/badge/codestyle-namics-green.svg)](https://github.com/namics/eslint-config-namics)
 
 ## Installation
 ```bash
-$ npm install --save-dev @namics/eslint-config
+$ npm install --save-dev eslint eslint-plugin-import @namics/eslint-config
 ```
 
 
@@ -18,13 +19,40 @@ $ npm install --save-dev @namics/eslint-config
 - `@namics/eslint-config/configurations/es5-browser` - ES5 + browser
 - `@namics/eslint-config/configurations/es5-node` - ES5 + node
 
-### .eslintrc.js
+### .eslintrc.js (add globals here if needed)
 ```
 module.exports = {
   "extends": "@namics/eslint-config/configurations/es6-browser.js"
 }
 ```
 
+### .eslintignore
+```
+/.idea/
+/node_modules/
+```
+
+### package.json
+```
+"scripts": {
+  "lint": "npm run lint:js",
+  "lint:js": "node_modules/.bin/eslint **/*.jsx **/*.js"
+},
+```
+then run `npm run lint`
+
+### Example usage in project tree
+- .eslintrc.js (es6-react)
+- .eslintignore
+- src
+    - app.jsx
+- test
+    - .eslintrc.js (es6-node)
+    - index.js
+- scripts
+    - .eslintrc.js (es5-node)
+    - index.js
+
 ## Documentation
 - [Best practices](./documentation/best-practices.md) (ES5 + ES6)
 - [Style](./documentation/style.md) (ES5 + ES6)
@@ -39,8 +67,8 @@ module.exports = {
 ## Thanks to
 * [Namics.](https://www.namics.com/en/)
 * [ESLint](https://github.com/eslint/eslint) for ESLint and the documentation [eslint.org](http://eslint.org/)
-* [Walmart](https://github.com/walmartlabs) for sharing their config in [eslint-config-walmart](https://github.com/airbnb/javascript)
-* [AirBnB](https://github.com/airbnb) for sharing their eslint config in [JavaScript Style Guide](https://github.com/walmartlabs/eslint-config-walmart)
+* [Walmart](https://github.com/walmartlabs) for sharing their config in [eslint-config-walmart](https://github.com/walmartlabs/eslint-config-walmart)
+* [AirBnB](https://github.com/airbnb) for sharing their eslint config in [JavaScript Style Guide](https://github.com/airbnb/javascript)
 
 
 ## License

documentation/react.md

@@ -111,7 +111,8 @@ const Hello = <Hello personal />;
 <Hello name={{ firstname: 'John', lastname: 'Doe' }} />;
 <Hello name={
   firstname
-} />;
+}
+/>;
 
 ```
 <br />