Update README and strip prettier configuration (for now)

Author: weirdpattern

README.md

@@ -1,2 +1,56 @@
 # eslint-config-typescript
 An opinionated set of ESLint rules for TypeScript projects
+
+## Installation
+Install eslint-config-typescript:
+
+```bash
+$ npm install --save-dev eslint-config-typescript
+```
+
+Then, add eslint-config-typescript to the "extends" array in your ESLint file. 
+Make sure to put it last, so it gets the chance to override other configs.
+
+```json
+{
+  "extends": [
+    "typescript"
+  ]
+}
+```
+
+A few ESLint plugins are supported as well:
+```json
+{
+  "extends": [
+    "typescript",
+    "typescript/react",
+    "typescript/prettier"
+  ]
+}
+```
+
+## Example configuration
+```json
+{
+  "extends": [
+    "typescript",
+    "typescript/react",
+    "typescript/prettier"
+  ],
+  "plugins": [
+    "typescript"
+  ],
+  "parserOptions": {
+    "ecmaVersion": 2016,
+    "sourceType": "module",
+    "ecmaFeatures": {
+      "jsx": true
+    }
+  },
+  "env": {
+    "es6": true,
+    "node": true
+  }
+}
+```

eslint.config.js

@@ -11,10 +11,17 @@
 module.exports = {
   extends: ['eslint:recommended', 'prettier'],
   plugins: ['prettier', 'filenames'],
+  parserOptions: {
+    sourceType: 'module',
+    ecmaVersion: 2015,
+    ecmaFeatures: {
+      jsx: true
+    }
+  },
   env: {
     es6: true,
     node: true,
-    jest: true,
+    jest: true
   },
   rules: {
     semi: 'error',
@@ -24,20 +31,20 @@ module.exports = {
     'no-console': [
       'error',
       {
-        allow: ['warn', 'error'],
-      },
+        allow: ['warn', 'error']
+      }
     ],
     'valid-jsdoc': [
       'error',
       {
         preferType: {
           any: '*',
-          object: 'Object',
+          object: 'Object'
         },
         requireReturnType: true,
         requireParamDescription: true,
-        requireReturnDescription: true,
-      },
+        requireReturnDescription: true
+      }
     ],
     quotes: ['error', 'single', { avoidEscape: true }],
     'jsx-quotes': ['error', 'prefer-single'],
@@ -51,8 +58,8 @@ module.exports = {
         bracketSpacing: true,
         jsxBracketSameLine: true,
         printWidth: 80,
-        parser: 'typescript',
-      },
-    ],
-  },
+        parser: 'typescript'
+      }
+    ]
+  }
 };

jest.config.js

@@ -12,18 +12,19 @@ module.exports = {
   moduleFileExtensions: ['js', 'jsx', 'ts', 'tsx'],
   testMatch: [
     '<rootDir>/specs/*[.-][Ss]pec[s]?.{j,t}s{,x}',
-    '<rootDir>/specs/**/*[.-][Ss]pec[s]?.{j,t}s{,x}',
+    '<rootDir>/specs/**/*[.-][Ss]pec[s]?.{j,t}s{,x}'
   ],
   rootDir: '.',
   verbose: false,
   resetMocks: true,
   resetModules: true,
   collectCoverage: false,
   collectCoverageFrom: [
-    '**/*.{j,t}s{,x}',
+    '{index,prettier,react}.{j,t}s{,x}',
+    'src/*.{j,t}s{,x}',
     '!**/*.min.js',
     '!**/static/**',
     '!**/specs/**',
-    '!**/node_modules/**',
-  ],
+    '!**/node_modules/**'
+  ]
 };