docs: readme 추가

humanscape · Jan 20, 2021 · 352724d · 352724d
1 parent 5b879e3
commit 352724d
Showing 1 changed file with 30 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,31 @@
 # ESLint Configurations for Humanscape
+
+### Installation & Usage
+
+1. Install `@humanscape/eslint-config`.
+
+Using `npm`
+
+`$ npm install --save-dev @humanscape/eslint-config`
+
+Using `yarn`
+
+`$ yarn add -D @humanscape/eslint-config`
+
+2. Add some ESLint config to `package.json`.
+
+```
+{
+  "eslintConfig": {
+    "extends": "@humanscape"
+  }
+}
+```
+
+or your preferred config file. (ex. `.eslintrc`)
+
+```
+{
+  "extends": "@humanscape"
+}
+```