chore(docs): correct case and match installation guide (#16)

README.md

@@ -4,8 +4,8 @@
 
 | Name                                            | Description          |
 | ----------------------------------------------- | -------------------- |
-| [eslint-config](packages/eslint-config)         | custom eslint config |
-| [eslint-plugin](packages/eslint-plugin)         | eslint plugin        |
-| [prettier-config](packages/prettier-config)     | prettier config      |
-| [stylelint-config](packages/stylelint-config)   | stylelint config     |
-| [typescript-config](packages/typescript-config) | typescript config    |
+| [eslint-config](packages/eslint-config)         | ESLint config        |
+| [eslint-plugin](packages/eslint-plugin)         | ESLint plugin        |
+| [prettier-config](packages/prettier-config)     | Prettier config      |
+| [stylelint-config](packages/stylelint-config)   | Stylelint config     |
+| [typescript-config](packages/typescript-config) | TypeScript config    |

packages/eslint-config/README.md

@@ -1,18 +1,18 @@
-# eslint-config
+# `@channel.io/eslint-config`
 
-An eslint configuration for channel web projects.
+ESLint configuration for Channel.io web projects
 
 ## Installation
 
 ### npm
 
-```
+```sh
 $ npm install --dev @channel.io/eslint-config
 ```
 
 ### Yarn
 
-```
+```sh
 $ yarn add --dev @channel.io/eslint-config
 ```
 

packages/eslint-config/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@channel.io/eslint-config",
   "version": "2.0.6",
-  "description": "eslint configuration for channel.io web",
+  "description": "ESLint configuration for Channel.io web projects",
   "main": "default.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",

packages/eslint-plugin/README.md

@@ -1,20 +1,35 @@
-# eslint-plugin
+# `@channel.io/eslint-plugin`
+
+ESLint plugins for Channel.io web projects
 
 ## Installation
-1. `$ npm install --dev @channel.io/eslint-plugin`
-
-2. Edit `.eslintrc.js`
-
-    ```js
-    module.exports = {
-      // ...
-      plugins: ['@channel.io'],
-      rules: {
-        '@channel.io/no-classnames-with-one-argument': 'error',
-        '@channel.io/hooks-deps-element-newline': 'warn'
-      }
-    }
-    ```
+
+### npm
+
+```sh
+$ npm install --dev @channel.io/eslint-plugin
+```
+
+### Yarn
+
+```sh
+$ yarn add --dev @channel.io/eslint-plugin
+```
+
+## Usage
+
+Edit `.eslintrc.js`
+
+```js
+module.exports = {
+  // ...
+  plugins: ['@channel.io'],
+  rules: {
+    '@channel.io/no-classnames-with-one-argument': 'error',
+    '@channel.io/hooks-deps-element-newline': 'warn'
+  }
+}
+```
 
 ## Docs
 > Documents are written by Korean only.

packages/eslint-plugin/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@channel.io/eslint-plugin",
   "version": "1.2.3",
-  "description": "eslint plugin for channel.io web",
+  "description": "ESLint plugins for Channel.io web projects",
   "author": "Channel Corp.",
   "main": "index.js",
   "scripts": {

packages/prettier-config/README.md

@@ -1,10 +1,18 @@
 # `@channel-io/prettier-config`
 
-Shared prettier configuration
+Shared Prettier configuration
 
 ## Installation
 
-```bash
+### npm
+
+```sh
+$ npm install --dev @channel.io/prettier-config
+```
+
+### Yarn
+
+```sh
 $ yarn add --dev @channel.io/prettier-config
 ```
 

packages/prettier-config/package.json

@@ -2,7 +2,7 @@
   "name": "@channel.io/prettier-config",
   "version": "0.0.1",
   "license": "MIT",
-  "description": "Shared prettier configuration",
+  "description": "Shared Prettier configuration",
   "main": "index.json",
   "sideEffects": false,
   "author": "Channel Corp.",

packages/stylelint-config/README.md

@@ -1,24 +1,41 @@
-# stylelint-config
+# `@channel.io/stylelint-config`
 
-An Configuration for stylelint by Channel.
+Configuration for Stylelint by Channel.io
 
 ## Installation
-`$ npm install --dev @channel.io/stylelint-config`
+
+### npm
+
+```sh
+$ npm install --dev @channel.io/stylelint-config
+```
+
+### Yarn
+
+```sh
+$ yarn add --dev @channel.io/stylelint-config
+```
 
 ## Install Packages
+
 Get peer dependency lists and install them.
 
-`$ npm info @channel.io/stylelint-config peerDependencies `
+```sh
+$ npm info @channel.io/stylelint-config peerDependencies
+```
 
 Or install with `install-peerdeps`.
 
-`$ npx install-peerdeps --dev @channel.io/stylelint-config`
+```sh
+$ npx install-peerdeps --dev @channel.io/stylelint-config
+```
+
+## Configure
+
+Create `.stylelintrc` file and extend this library.
 
-### Configure
-create `.stylelintrc` file and extend this library.
 ```js
 {
   "extends": ["@channel-io/stylelint-config"],
 }
-
 ```

packages/stylelint-config/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@channel.io/stylelint-config",
   "version": "1.2.0",
-  "description": "Configuration for stylelint by Channel",
+  "description": "Configuration for Stylelint by Channel.io",
   "main": "index.js",
   "files": [
     "index.js"

packages/typescript-config/README.md

@@ -1,10 +1,18 @@
-# typescript-config
+# `@channel.io/typescript-config`
 
-Base typescript configuration for Channel.io
+Base TypeScript configuration for Channel.io
 
 ## Installation
 
-```bash
+### npm
+
+```sh
+$ npm install --dev @channel.io/typescript-config
+```
+
+### Yarn
+
+```sh
 $ yarn add --dev @channel.io/typescript-config
 ```
 

packages/typescript-config/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@channel.io/typescript-config",
   "version": "0.0.1",
-  "description": "Typescript configuration for Channel.io",
+  "description": "Base TypeScript configuration for Channel.io",
   "author": "Channel Corp.",
   "bugs": {
     "url": "https://github.com/channel-io/shared-configs/issues"