Skip to content

Commit

Permalink
Update README.md of the Eslint Config to link to the Coding Standards
Browse files Browse the repository at this point in the history
  • Loading branch information
mediamonks-thijs committed Nov 12, 2020
1 parent 11277e5 commit b434c54
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions eslint-config/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.
This eslint-configuration uses [Prettier](https://prettier.io/) for the formatting. Please make sure you use the same [Prettier configuration](.prettierrc) to avoid conflicts.

0 comments on commit b434c54

Please sign in to comment.