Skip to content
This repository has been archived by the owner on Oct 19, 2018. It is now read-only.

Commit

Permalink
docs: Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Kevin Ruff committed Feb 20, 2018
1 parent 3e2c2d7 commit 2787122
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,30 @@
[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovateapp.com/)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

This package servers as the basis for the JavaScript standards of the Immowelt GmbH.

It sets a bunch of rules and warnings for best practices on how to write a maintainable JavaScript code base, as well as hints on how to write a good performing es6 application.
This package provides **ES6** (+ES5) specific configurations used by [ImmoweltGroup](https://github.com/ImmoweltGroup).

## Usage

If you want to use the `@immowelt/eslint-config-immowelt-es6` config, you can install it by executing:
Add it to your dependencies.

```bash
npm i -D @immowelt/eslint-config-immowelt-es6
```

Then create a file named `.eslintrc` with following contents in the root folder of your project:
Use it in your ESLint settings.

```json
{
"extends": "@immowelt/eslint-config-immowelt-es6"
}
```

# Commit guidelines and semantic release
## Bundle

* [eslint-config-immowelt-es5](https://github.com/ImmoweltGroup/eslint-config-immowelt-es5)
* [eslint-config-immowelt-es6](https://github.com/ImmoweltGroup/eslint-config-immowelt-es6)
* [eslint-config-immowelt-react](https://github.com/ImmoweltGroup/eslint-config-immowelt-react)

Our repositories make great use of [semantic-release](https://semantic-release.gitbooks.io/semantic-release/content/#how-does-it-work). Please follow the release guidelines.
## License

## Licensing
See the `LICENSE` file at the root of the repository.

0 comments on commit 2787122

Please sign in to comment.