Update readme and installation method

wyze · Mar 22, 2017 · 5a278ab · 5a278ab
1 parent c847665
commit 5a278ab
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 11 deletions.
diff --git a/package.json b/package.json
@@ -39,6 +39,29 @@
       "no-bitwise": 0
     }
   },
+  "config": {
+    "basePeers": {
+      "eslint": "^3.18.0",
+      "eslint-config-airbnb": "^14.1.0",
+      "eslint-plugin-eslint-comments": "^1.0.0",
+      "eslint-plugin-import": "^2.2.0",
+      "eslint-plugin-wyze": "^3.1.0"
+    },
+    "reactPeers": {
+      "eslint": "^3.18.0",
+      "eslint-config-airbnb": "^14.1.0",
+      "eslint-plugin-eslint-comments": "^1.0.0",
+      "eslint-plugin-import": "^2.2.0",
+      "eslint-plugin-jsx-a11y": "^4.0.0",
+      "eslint-plugin-react": "^6.10.0",
+      "eslint-plugin-wyze": "^3.1.0"
+    },
+    "flowPeers": {
+      "babel-eslint": "^7.1.0",
+      "eslint": "^3.18.0",
+      "eslint-plugin-flowtype": "^2.30.0"
+    }
+  },
   "peerDependencies": {
     "babel-eslint": "^7.1.0",
     "eslint": "^3.18.0",

diff --git a/readme.md b/readme.md
@@ -8,26 +8,30 @@
 
 ## Installation
 
-Use `yarn add --dev <packages>` where `<packages>` are as follows:
+> *Note*: The below commands will generate the command you will need to run for installation. You can replace `yarn add --dev` with `npm i --save-dev` if not using Yarn.
 
-> **Note**: You can also do `npm i --save-dev <packages>`.
+### Base
 
-### React/Preact
-
-```
-eslint eslint-config-airbnb eslint-config-wyze eslint-plugin-eslint-comments eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-wyze
+```sh
+(
+  export PKG=eslint-config-wyze; npm info $PKG config.basePeers --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs echo yarn add --dev $PKG
+)
 ```
 
-### Non-React
+### Preact/React
 
-```
-eslint eslint-config-airbnb eslint-config-wyze eslint-plugin-eslint-comments eslint-plugin-import eslint-plugin-wyze
+```sh
+(
+  export PKG=eslint-config-wyze; npm info $PKG config.reactPeers --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs echo yarn add --dev $PKG
+)
 ```
 
 ### Flow
 
-```
-babel-eslint eslint eslint-config-wyze eslint-plugin-flowtype
+```sh
+(
+  export PKG=eslint-config-wyze; npm info $PKG config.flowPeers --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs echo yarn add --dev $PKG
+)
 ```
 
 ## Usage
@@ -66,6 +70,20 @@ babel-eslint eslint eslint-config-wyze eslint-plugin-flowtype
 }
 ```
 
+## Peer Dependencies
+
+| Package | Base | Preact/React | Flow |
+|---------|:----:|:------------:|:----:|
+| babel-eslint | | | :package: |
+| eslint | :package: | :package: | :package: |
+| eslint-config-airbnb | :package: | :package: | |
+| eslint-plugin-eslint-comments | :package: | :package: | |
+| eslint-plugin-flowtype | | | :package: |
+| eslint-plugin-import | :package: | :package: | |
+| eslint-plugin-jsx-a11y | | :package: | |
+| eslint-plugin-react | | :package: | |
+| eslint-plugin-wyze | :package: | :package: | |
+
 ## Change Log
 
 > [Full Change Log](changelog.md)