From f36b1c058873b7a0bc8e275ab5591e89af05129b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thea=20Sch=C3=B6bl?= Date: Thu, 21 Apr 2022 00:18:18 +0200 Subject: [PATCH] docs: update docs --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 82fd2720..452bac93 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,14 @@ ## Installation +Put this into your `.eslintrc` + +```json +{ + "extends": "@openstapps" +} +``` + Unfortunately, ESLint requires you to define plugins and configs your config depends on as `peerDependencies`, which means they have to be installed manually. @@ -17,7 +25,7 @@ Use the command npx install-peerdeps --dev @openstapps/eslint-config ``` -Add either the following to your `package.json`: +Or, alternatively, add the following to your `package.json`: ```json {