feat: defined the initial config

Author: travi

.eslintcache

@@ -0,0 +1 @@
+[{"/Users/travi/development/form8ion/eslint-config-typescript/index.js":"1"},{"size":136,"mtime":1630636116007,"results":"2","hashOfConfig":"3"},{"filePath":"4","messages":"5","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"1apq2cj","/Users/travi/development/form8ion/eslint-config-typescript/index.js",[]]

.eslintrc.yml

@@ -0,0 +1,4 @@
+root: true
+extends:
+  - '@form8ion'
+  - '.'

.remarkrc.js

@@ -9,6 +9,5 @@ exports.settings = {
 
 exports.plugins = [
   '@form8ion/remark-lint-preset',
-  ['remark-toc', {tight: true}],
-  ['remark-usage', {heading: 'example'}]
-];
+  ['remark-toc', {tight: true}]
+];

README.md

@@ -14,7 +14,7 @@
 
 * [Usage](#usage)
   * [Installation](#installation)
-  * [Example](#example)
+  * [Add to the project config](#add-to-the-project-config)
 * [Contributing](#contributing)
   * [Dependencies](#dependencies)
   * [Verification](#verification)
@@ -34,10 +34,14 @@
 $ npm install @form8ion/eslint-config-typescript --save-dev
 ```
 
-### Example
+### Add to the project config
 
-```javascript
-const eslintConfigTypescript = require('.');
+Such as in an `.eslintrc.js`
+
+```js
+module.exports = {
+  extends: ['@form8ion', '@form8ion/typescript']
+};
 ```
 
 ## Contributing

example.js

@@ -0,0 +1,5 @@
+module.exports = {
+  extends: ['plugin:import/typescript'],
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint']
+};