eslint-config-logux/README.md

An ESLint shareable config for Logux

# Logux ESLint Config

<img align="right" width="95" height="95" alt="Logux logo"
     src="https://cdn.rawgit.com/logux/logux/master/logo.svg">

Shareable code style and best practice for [Logux] projects.

[Logux]: https://github.com/logux/logux

## Install

For browser and universal project:

```sh
yarn add --dev eslint-config-logux eslint-config-standard eslint-plugin-promise eslint-plugin-jest eslint-plugin-node eslint-plugin-es5 eslint-plugin-standard eslint-plugin-security eslint-plugin-import eslint
```

For server-only project you can use config with ES2015+ support:

```sh
yarn add --dev eslint-config-logux eslint-config-standard eslint-plugin-promise eslint-plugin-jest eslint-plugin-node eslint-plugin-standard eslint-plugin-security eslint-plugin-import eslint-plugin-prefer-let eslint
```

## Usage

Add this config to `package.json` or other ESLint config.

Browser and universal project:

```sh
  "eslintConfig": {
    "extends": "eslint-config-logux/browser"
  }
```

Server-only project:

```sh
  "eslintConfig": {
    "extends": "eslint-config-logux/node"
  }
```