Skip to content
This repository was archived by the owner on Aug 7, 2023. It is now read-only.

Commit bce1823

Browse files
authored
chore(readme): Update README.md (#1247)
Minor fixes for clarity and concision.
1 parent 3874c5d commit bce1823

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ apm install linter-eslint
1717
use it if it's available. If none is found it will fall back to the version it
1818
ships with.
1919

20-
Lets say you depend on a specific version of `eslint`, maybe it has unreleased
21-
features, maybe it's just newer than what `linter-eslint` ships with. If
20+
Let's say you depend on a specific version of `eslint`. Maybe it has unreleased
21+
features or maybe it's newer than what `linter-eslint` ships with. If
2222
`your-project/node_modules/eslint` exists `linter-eslint` will be used.
2323
This package requires an `eslint` of at least v1.0.0.
2424

25-
Note that if you do not have the `linter` package installed it will be
25+
If you do not have the `linter` package installed, it will be
2626
installed
27-
for you. If you are using an alternative `linter-*` consumer feel free
28-
to disable the `linter` package.
27+
for you. If you are using an alternative `linter-*` consumer,
28+
the `linter` package can be disabled.
2929

3030
## Use with plugins
3131

@@ -43,7 +43,7 @@ You have two options:
4343

4444
## Using ESLint
4545

46-
Note that recent versions of ESLint do not use any rules by-default. This
46+
Note that recent versions of ESLint do not use any rules by default. This
4747
means you have to specify a configuration file for your project!
4848

4949
To do this in a straightforward way run this:
@@ -62,10 +62,10 @@ If Use Global is on, Atom will use the global ESLint. The path to it is figured
6262

6363
If Use Global is off, Atom will try to find a local installation in the project folder, look if there's ESLint in `${PROJECT_ROOT}/node_modules` and use it if found.
6464

65-
The path to the local node_modules folder can be a path relative to the project or an absolute path and should end in /node_modules/. This path is used if the other methods of discovery have failed.
65+
The path to the local node_modules folder can be a path relative to the project or an absolute path and should end in `/node_modules/`. This path is used if the other methods of discovery have failed.
6666

6767
If there is no local installation Atom will use the built-in ESLint in the linter-eslint package itself.
6868

6969
## Contributing
7070

71-
See the [contributing guidelines](./CONTRIBUTING.md) to get started
71+
See the [contributing guidelines](./CONTRIBUTING.md) to get started.

0 commit comments

Comments
 (0)