Skip to content

Commit 8c12939

Browse files
authored
Clarify usage with/without XO in readme (#27)
1 parent 98bf8eb commit 8c12939

File tree

1 file changed

+5
-21
lines changed

1 file changed

+5
-21
lines changed

readme.md

Lines changed: 5 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@
88
$ npm install --save-dev eslint-config-xo eslint-config-xo-typescript @typescript-eslint/parser @typescript-eslint/eslint-plugin
99
```
1010

11-
## Usage
11+
## Usage with XO
12+
13+
[XO has built-in support for TypeScript](https://github.com/xojs/xo#typescript), using this package under the hood, so you do not have to configure anything.
14+
15+
## Standalone Usage
1216

1317
Add some ESLint config to your package.json (or `.eslintrc`):
1418

@@ -55,26 +59,6 @@ Use the `space` sub-config if you want 2 space indentation instead of tabs:
5559
}
5660
```
5761

58-
## Tip
59-
60-
### Use with XO
61-
62-
```
63-
$ npm install --save-dev eslint-config-xo-typescript @typescript-eslint/parser @typescript-eslint/eslint-plugin
64-
```
65-
66-
```json
67-
{
68-
"name": "my-awesome-project",
69-
"xo": {
70-
"extends": "xo-typescript",
71-
"extensions": [
72-
"ts"
73-
]
74-
}
75-
}
76-
```
77-
7862
## Related
7963

8064
- [eslint-config-xo](https://github.com/xojs/eslint-config-xo) - ESLint shareable config for XO

0 commit comments

Comments
 (0)