Skip to content

Commit

Permalink
fix(doc): add language annotation to code blocks in README
Browse files Browse the repository at this point in the history
Update the code blocks in the readme to include a language annotation so
rendering engines may apply syntax highlighting.

The goal is to prevent too much logic being crammed on to a single line

Semver: patch
  • Loading branch information
esatterwhite committed Sep 30, 2020
1 parent 5caf579 commit 8b63b65
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This package contains the `eslint` configuration that LogDNA prefers to use acro

We do not use peer dependencies, so make sure that `eslint` is also installed as a dev dependency.

```
```shell
npm install eslint-config-logdna eslint --save-dev
```

Expand All @@ -20,7 +20,7 @@ Once the package is installed, there are a few easy steps to get it executing wi

It is best if `eslint` is configured as a script in `package.json` and hooked in as `pre` scripts where necessary.

```
```javascript
"scripts": {
"lint": "eslint .",
"pretest": "npm run lint"
Expand All @@ -33,7 +33,7 @@ Add this configuration section to the `package.json` file of the target project.
specific to the project that needs linting. The `ignorePatterns` is only important for directories that may contain `.js`
files since `eslint` will only lint javascript files by default.

```
```javascript
"eslintConfig": {
"extends": [
"logdna"
Expand Down

0 comments on commit 8b63b65

Please sign in to comment.