diff --git a/README.md b/README.md index 2089604..55173c8 100644 --- 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" +} +```