Skip to content

docs: improve installation chapter in README #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve installation chapter in README #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,13 @@ this repo for various other programming languages and frameworks.
Install `@siemens/*-config*` and their peer dependencies in your project (whichever you need):

```bash
npm install @siemens/stylelint-config-scss --save-dev --save-exact
npm install @siemens/stylelint-config-scss stylelint-use-logical-spec --save-dev --save-exact
npm install @siemens/commitlint-config --save-dev --save-exact
npm install @siemens/prettier-config --save-dev --save-exact
npm install @siemens/eslint-config-typescript --save-dev --save-exact
npm install @siemens/eslint-config-angular --save-dev --save-exact
# It is recommended to install the package with typescript-eslint since npm will show a version conflict if the dependency is not directly listed under devDependencies
npm install @siemens/eslint-config-typescript typescript-eslint --save-dev --save-exact
# It is recommended to install the package with typescript-eslint and angular-eslint since npm will show a version conflict if the dependency is not directly listed under devDependencies
npm install @siemens/eslint-config-angular typescript-eslint angular-eslint --save-dev --save-exact
```

**_Note_** _You should specify the exact versions of the packages above and
Expand Down