Skip to content

Commit

Permalink
Merge pull request #4 from moderntribe/readme-release-updates
Browse files Browse the repository at this point in the history
Readme release updates
  • Loading branch information
nealfennimore authored Apr 12, 2018
2 parents 6e66f92 + 74b554d commit abe6e93
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,22 @@ Custom config that extends [wpcalypso](https://github.com/Automattic/eslint-conf

## Installation

Using npm:
```sh
npm install --save-dev github:moderntribe/eslint-config-products

# Target branch or release:
# npm install --save-dev github:moderntribe/eslint-config-products#branch-name
# npm install --save-dev github:moderntribe/eslint-config-products#v0.0.1
```

Using yarn:
```sh
yarn add --dev github:moderntribe/eslint-config-products

# Target branch or release:
# yarn add --dev github:moderntribe/eslint-config-products#branch-name
# yarn add --dev github:moderntribe/eslint-config-products#v0.0.1
```

### Add .eslintrc file
Expand All @@ -25,7 +36,7 @@ In the root directory, add in an `.eslintrc` file.
}
```

## Using React eslint config
### Using React eslint config

Update `.eslintrc` to:

Expand All @@ -34,3 +45,13 @@ Update `.eslintrc` to:
extends: 'products/react'
}
```

## Creating release version

First, bump the package.json version number to the latest version number.

Then create a new tag for updated config in git:
```sh
git tag v0.0.5
git push --tags
```

0 comments on commit abe6e93

Please sign in to comment.