updated docs:

- new section: Setup
- added Jest config

Author: piotrwitek

CHANGELOG.md

@@ -0,0 +1,8 @@
+## 2016-12-20
+> FIRST COMMIT
+
+## 2017-10-27
+> STARTED CHANGELOG
+- added improved "redux" types, from redux's `next` branch (check in the new [Setup](#setup) section)  
+- added new section: Setup
+- added Jest config

docs/markdown/0_setup.md

@@ -0,0 +1,17 @@
+# Setup
+
+## Installing types
+```
+npm i -D @types/react @types/react-dom @types/react-redux
+```
+
+"react" - `@types/react`  
+"react-dom" - `@types/react-dom`  
+"redux" - (included in npm package)*  
+"react-redux" - `@types/react-redux`  
+
+> *There are improved redux types on a `next` branch in the official redux github repo, use below instructions to add it to your project:
+- in `package.json > devDependencies` add:  
+  `"redux-next": "reactjs/redux#next"`  
+- in `tsconfig.json > compilerOptions > paths` add:  
+  `"redux": ["node_modules/redux-next"]`  

docs/markdown/4_extras.md

@@ -54,13 +54,13 @@
 ```
 
 ### tslint.json
-> - Recommended setup is to extend build-in preset `tslint:latest` (for all rules use `tslint:all`)  
+> - Recommended setup is to extend build-in preset `tslint:recommended` (for all rules use `tslint:all`)  
 > - Add tslint react rules: `npm i -D tslint-react` https://github.com/palantir/tslint-react  
 > - Amended some extended defaults for more flexibility  
 
 ```json
 {
-  "extends": ["tslint:latest", "tslint-react"],
+  "extends": ["tslint:recommended", "tslint-react"],
   "rules": {
     "arrow-parens": false,
     "arrow-return-shorthand": [false],
@@ -75,11 +75,13 @@
     "newline-before-return": false,
     "no-any": false,
     "no-empty-interface": false,
+    "no-import-side-effect": [true],
     "no-inferrable-types": [true, "ignore-params", "ignore-properties"],
     "no-invalid-this": [true, "check-function-in-method"],
     "no-null-keyword": false,
     "no-require-imports": false,
     "no-switch-case-fall-through": true,
+    "no-submodule-imports": [true, "rxjs", "@src"],
     "no-trailing-whitespace": true,
     "no-this-assignment": [true, {
       "allow-destructuring": true
@@ -101,6 +103,35 @@
 }
 ```
 
+### jest.config.json
+> - Recommended setup for Jest with TypeScript  
+> - Install with `npm i -D jest-cli ts-jest`  
+
+```json
+{
+  "verbose": true,
+  "transform": {
+    ".(ts|tsx)": "./node_modules/ts-jest/preprocessor.js"
+  },
+  "testRegex": "(/spec/.*|\\.(test|spec))\\.(ts|tsx|js)$",
+  "moduleFileExtensions": [
+    "ts",
+    "tsx",
+    "js"
+  ],
+  "globals": {
+    "window": {},
+    "ts-jest": {
+      "tsConfigFile": "./tsconfig.json"
+    }
+  },
+  "setupFiles": [
+    "./jest.stubs.js",
+    "./src/rxjs-imports.tsx"
+  ]
+}
+```
+
 ### Default and Named Module Exports
 > Most flexible solution is to use module folder pattern, because you can leverage both named and default import when you see fit.  
 Using this solution you'll achieve better encapsulation for internal structure/naming refactoring without breaking your consumer code:  

docs/markdown/5_faq.md

@@ -1,13 +1,5 @@
 # FAQ
 
-### - how to install react & redux types?
-```
-// react
-npm i -D @types/react @types/react-dom @types/react-redux
-
-// redux has types included in it's npm package - don't install from @types
-```
-
 ### - should I still use React.PropTypes in TS?
 > No. When using TypeScript it is an unnecessary overhead, when declaring IProps and IState interfaces, you will get complete intellisense and compile-time safety with static type checking, this way you'll be safe from runtime errors and you will save a lot of time on debugging. Additional benefit is an elegant and standarized method of documenting your component external API in the source code.  
 

docs/markdown/_intro.md

@@ -4,11 +4,11 @@ This guide is about **_"How to write type declarations to only the minimum neces
 
 > found it usefull, want some more? [give it a :star:](https://github.com/piotrwitek/react-redux-typescript-patterns/stargazers)  
 
-#### Announcements
-- All the examples ported to TypeScript v2.5 and using recent type definitions for `react` & `redux`  [TypeScript Changelog](https://github.com/Microsoft/TypeScript/wiki/Roadmap)  
-- create more strict type definitions for redux  
+### [> Changelog](/blob/master/CHANGELOG.md)  
+
+### Roadmap
 - extend HOC section with more advanced examples [#5](/issues/5)  
-- investigate typing patterns for component children [#7](/issues/7)  
+- investigate typing patterns for generic component children [#7](/issues/7)  
 
 ### Introduction
 This guide is aimed to use [`--strict`](https://www.typescriptlang.org/docs/handbook/compiler-options.html) flag of TypeScript compiler to provide the best static-typing experience.  

docs/markdown/_toc.md

@@ -1,4 +1,5 @@
 ### Table of Contents
+- [Setup](#setup)
 - [React](#react)
   - [Stateless Components - SFC](#stateless-components---sfc)
   - [Stateful Components - Class](#stateful-components---class)
@@ -13,11 +14,10 @@
 - [Ecosystem](#ecosystem)
   - [Async Flow with "redux-observable"](#async-flow-with-redux-observable)
   - [Selectors with "reselect"](#selectors-with-reselect)
-  - Forms with "formstate" WIP
-  - Styles with "typestyle" WIP
 - [Extras](#extras)
   - [tsconfig.json](#tsconfigjson)
   - [tslint.json](#tslintjson)
+  - [jest.config.json](#jestconfigjson)  
   - [Default and Named Module Exports](#default-and-named-module-exports)
   - [Vendor Types Augmentation](#vendor-types-augmentation)
 - [FAQ](#faq)

generator/src/generate-readme.ts

@@ -7,6 +7,7 @@ const DOCS_PATH = TOP_LEVEL_PATH + 'docs/markdown/'
 const inputFiles = [
   DOCS_PATH + '_intro.md',
   DOCS_PATH + '_toc.md',
+  DOCS_PATH + '0_setup.md',
   DOCS_PATH + '1_react.md',
   DOCS_PATH + '2_redux.md',
   DOCS_PATH + '3_ecosystem.md',