diff --git a/eslint-config/README.md b/eslint-config/README.md index bbcda12..2ef87c1 100644 --- a/eslint-config/README.md +++ b/eslint-config/README.md @@ -1,8 +1,6 @@ -# MediaMonks - Frontend Coding Standards +# MediaMonks - Eslint Configuration -## Eslint Configuration - -To make sure your project is following the MediaMonks Frontend Coding Standards you should install `@mediamonks/eslint-config` and its peer dependencies as an [eslint extension](https://eslint.org/docs/user-guide/configuring#extending-configuration-files): +To make sure your project is following the [MediaMonks - Frontend Coding Standards](https://github.com/mediamonks/frontend-coding-standards) you should install `@mediamonks/eslint-config` and its peer dependencies as an [eslint extension](https://eslint.org/docs/user-guide/configuring#extending-configuration-files): ``` npx install-peerdeps --dev @mediamonks/eslint-config @@ -19,4 +17,4 @@ module.exports = { This Eslint extension is configured for JavaScript, [TypeScript](http://typescriptlang.org/), [React](https://reactjs.org/), [Vue](https://vuejs.org/) and [Muban](https://mediamonks.github.io/muban/) projects. #### Prettier -This eslint-configuration uses [Prettier](https://prettier.io/) for the formatting. Please make sure you use the same [Prettier configuration](.prettierrc) to avoid conflicts. \ No newline at end of file +This eslint-configuration uses [Prettier](https://prettier.io/) for the formatting. Please make sure you use the same [Prettier configuration](.prettierrc) to avoid conflicts.