Skip to content

Commit e448af9

Browse files
authored
docs: some typos and small fixes (#3)
Some typos and small fixes
1 parent 146243a commit e448af9

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
</h1>
44

55
<p align="center">
6-
A modern <a href="https://eslint.org/">ESlint</a> configuration for <a href="https://www.ecma-international.org/publications-and-standards/standards/ecma-262/">JavaScript</a>, <a href="https://www.typescriptlang.org/">TypeScript</a> and <a href="https://reactjs.org/">React</a> that includes the <a href="https://github.com/airbnb/javascript">Airbnb</a> style guide, <a href="https://github.com/jsx-eslint/eslint-plugin-jsx-a11y">jsx-a11y</a> to help with accessibility and <a href="https://www.npmjs.com/package/eslint-plugin-prettier">Pettier</a> to do some code formatting.
6+
A modern <a href="https://eslint.org/">ESlint</a> configuration for <a href="https://www.ecma-international.org/publications-and-standards/standards/ecma-262/">JavaScript</a>, <a href="https://www.typescriptlang.org/">TypeScript</a> and <a href="https://reactjs.org/">React</a> that includes the <a href="https://github.com/airbnb/javascript">Airbnb</a> style guide, <a href="https://github.com/jsx-eslint/eslint-plugin-jsx-a11y">jsx-a11y</a> to help with accessibility and <a href="https://www.npmjs.com/package/eslint-plugin-prettier">Prettier</a> to do some code formatting.
77
</p>
88

99
<p align="center">
@@ -18,23 +18,23 @@
1818

1919
## A bit of context
2020

21-
It's always a bit time consuming to create or maintain different [ESlint](https://eslint.org/) configurations that works with different languages and libraries such as [TypeScript](https://www.typescriptlang.org/) and [React](https://reactjs.org/). The goal of this package is to have different configurations that just work out-of-the-box and that are constantly kept up-to-date.
21+
It's always a bit time consuming to create or maintain different [ESlint](https://eslint.org/) configurations that work with different languages and libraries such as [TypeScript](https://www.typescriptlang.org/) and [React](https://reactjs.org/). The goal of this package is to have different configurations that just work out-of-the-box and are constantly kept up-to-date.
2222

2323
## Getting Started 🚀
2424

25-
Installing this packge is has as easy has any other packages. Simply use your favorite package manager. You'll need to install the required peer dependencies and than this packge.
25+
Installing this package is as easy as any other packages. Simply use your favorite package manager. Keep in mind you'll need to install the required peer dependencies first.
2626

2727
### Install ESlint and Prettier peer dependencies
2828

29-
Install [ESlint](https://eslint.org/) and [Prettier](https://prettier.io/) either locally or globally. (Note that locally, per project, is strongly preferred)
29+
Install [ESlint](https://eslint.org/) and [Prettier](https://prettier.io/) either locally or globally. Note that locally per project is strongly preferred.
3030

3131

3232
```sh
3333
npm install eslint@8 --save-dev
3434
npm install prettier@2 --save-dev --save-exact
3535
```
3636

37-
If you use [TypeScript](https://www.typescriptlang.org/) or [React](https://reactjs.org/) you'll also need to install them, but let's assume they're already installed. We'll only support most recent version. Have a look at the `peerDependencies` field in the package.json to know which one we support.
37+
If you use [TypeScript](https://www.typescriptlang.org/) or [React](https://reactjs.org/) you'll also need to install them, but let's assume they're already installed. We'll only support most recent versions. Have a look at the `peerDependencies` field in the `package.json` file to know which versions are supported.
3838

3939
### Install easelint
4040

@@ -44,7 +44,7 @@ npm install easelint --save-dev
4444

4545
### Setup the configuration file
4646

47-
Using any [file formats](https://eslint.org/docs/user-guide/configuring/configuration-files#configuration-file-formats) supported by [ESlint](https://eslint.org/), youll need to add `"100terres"` in the `"extends"` value of the configuration. Here's an example using a `.eslintrc.js` file.
47+
Using any [file formats](https://eslint.org/docs/user-guide/configuring/configuration-files#configuration-file-formats) supported by [ESlint](https://eslint.org/), you'll need to add `"100terres"` in the `"extends"` value of the configuration. Here's an example using a `.eslintrc.js` file.
4848

4949
#### Using the full configuration with JavaScript, TypeScript and React
5050

@@ -77,7 +77,7 @@ Voilà! Your project now uses a linter.
7777

7878
## How to Contribute 🤝
7979

80-
Pull requests are welcome. If you'd like to contribute to easelint, that's awesome. Simply open an issue explaining what we should change, improve or fix. If we decide that a change is required we can open a pull request and once everything looks good I'll approve and merge the PR.
80+
Pull requests are welcomed. If you'd like to contribute to `easelint`, that's awesome. Simply open an issue explaining what should be changed, improved or fixed. If we decide that a change is required, we can open a pull request. Once everything looks good, I'll approve and merge the PR.
8181

8282
## License
8383

0 commit comments

Comments
 (0)