Merge pull request #11 from CoditEU/feature/move-to-org-codit

✏️ update docs + 📦 update package.json

Author: THMKAE

README.md

@@ -1,4 +1,4 @@
-# Unbrace ESLint Config
+# Codit ESLint Config
 
 _A fair-minded way to reduce noise in Javascript_
 
@@ -13,7 +13,7 @@ The package contains our ESLint rules, including ES6, React, TypeScript, FlowTyp
 ### Installation
 
 ```
-yarn add eslint-config-unbrace eslint@^6.8.0 --dev
+yarn add @codit/eslint-config eslint@^6.8.0 --dev
 ```
 
 Install dependencies. ESLint plugins [must also be installed](https://github.com/eslint/rfcs/pull/5).
@@ -29,7 +29,7 @@ The following configuration contains a setup for ES6, React, TypeScript & Pretti
 ```
   "eslintConfig": {
     "extends": [
-      "unbrace"
+      "@codit"
     ]
   }
 ```
@@ -39,23 +39,29 @@ Or if you want to take more control or don't use TypeScript, you can also extend
 ```
 "eslintConfig": {
     "extends": [
-      "unbrace/core",
-      "unbrace/flowtype",
-      "unbrace/lodash",
-      "unbrace/react"
+      "@codit/core",
+      "@codit/flowtype",
+      "@codit/lodash",
+      "@codit/react"
     ]
   }
 
 // or
 
 "eslintConfig": {
     "extends": [
-      "unbrace/core",
-      "unbrace/es5"
+      "@codit/core",
+      "@codit/es5"
     ]
   }
 ```
 
+## Older versions
+
+Documentation for versions 1.x.x can be found in the docs folder:
+
+- [Version 1.x.x](./docs/version-1.x.x.md)
+
 ## License
 
 [MIT](LICENSE)

docs/version-1.x.x.md

@@ -0,0 +1,56 @@
+# Version 1.x.x
+
+Documentation for all versions below 2.x.x
+Version 1.x.x has support for FlowType & Lodash which we are no longer supporting @ Codit and moving forward with version 2.x.x
+
+## Usage
+
+### Installation
+
+```
+yarn add eslint-config-unbrace eslint@^6.8.0 --dev
+```
+
+Install dependencies. ESLint plugins [must also be installed](https://github.com/eslint/rfcs/pull/5).
+
+```
+yarn add -D eslint-plugin-babel@^5.3.0 eslint-plugin-filenames@^1.3.2 eslint-plugin-import@^2.19.1 eslint-plugin-promise@^4.2.1 eslint-plugin-react@^7.17.0 eslint-config-prettier@^6.9.0
+```
+
+### Configuration
+
+The following configuration contains a setup for ES6, React, TypeScript & Prettier
+
+```
+  "eslintConfig": {
+    "extends": [
+      "unbrace"
+    ]
+  }
+```
+
+Or if you want to take more control or don't use TypeScript, you can also extend the packages as follows (make sure to also install the correct dependencies, FlowType & Lodash f.e. are not listed in the step above):
+
+```
+"eslintConfig": {
+    "extends": [
+      "unbrace/core",
+      "unbrace/flowtype",
+      "unbrace/lodash",
+      "unbrace/react"
+    ]
+  }
+
+// or
+
+"eslintConfig": {
+    "extends": [
+      "unbrace/core",
+      "unbrace/es5"
+    ]
+  }
+```
+
+## License
+
+[MIT](LICENSE)

package.json

@@ -1,22 +1,21 @@
 {
-  "name": "eslint-config-unbrace",
+  "name": "@codit/eslint-config",
   "version": "1.1.0",
-  "description": "Unbrace's shareable EsLint configuration",
+  "description": "Codit's shareable EsLint configuration",
   "main": "index.js",
   "repository": {
     "type": "git",
-    "url": "https://github.com/unbrace/eslint-config-unbrace.git"
+    "url": "https://github.com/CoditEU/eslint-config-codit.git"
   },
   "keywords": [
     "eslint",
     "eslint-config",
     "react",
     "typescript",
     "javascript",
-    "lodash",
-    "unbrace"
+    "codit"
   ],
-  "author": "Erwin Govaerts <erwin.govaerts@unbrace.be>",
+  "author": "Erwin Govaerts <erwin.govaerts@codit.eu>",
   "license": "MIT",
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^4.1.1",