Skip to content

Commit

Permalink
docs: 📝 improve README by fixing spelling mistakes
Browse files Browse the repository at this point in the history
  • Loading branch information
jimmy-guzman committed Apr 8, 2024
1 parent 12c9fcd commit 74e1efc
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,20 +48,20 @@ import jimmyDotCodes from "@jimmy.codes/eslint-config";

export default jimmyDotCodes({
/**
* Wether or not TypeScript rules are enabled?
* Are TypeScript rules are enabled?
* @default false
*/
typescript: false,
typescript: true,
/**
* Are React rules are enabled?
* @default false
*/
react: false,
react: true,
/**
* Are testing rules are enabled?
* @default false
*/
testing: false,
testing: true,
});
```

Expand Down Expand Up @@ -98,7 +98,7 @@ export default jimmyDotCodes({

#### Overrides

Or if you want to extend or override the configuration:
You can also extend or override the configuration:

```js
// eslint.config.mjs
Expand All @@ -121,6 +121,7 @@ export default jimmyDotCodes({
});
```

## ️ Credits
## ️ Credits

- [antfu/eslint-config](https://github.com/antfu/eslint-config) by [@antfu](https://antfu.me/)
- [@antfu/eslint-config](https://github.com/antfu/eslint-config) by [Anthony Fu](https://antfu.me)
- [@pvtnbr/eslint-config](https://github.com/privatenumber/eslint-config) by [Hiroki Osame](https://hirok.io/)
4 changes: 4 additions & 0 deletions cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,18 @@
"eslintconfig",
"gitzy",
"gruntfuggly",
"Hiroki",
"jiti",
"lcov",
"lefthook",
"lockb",
"nuxt",
"nvmrc",
"Osame",
"pkgroll",
"pnpm",
"privatenumber",
"pvtnbr",
"setstate",
"shellcheck",
"streetsidesoftware",
Expand Down

0 comments on commit 74e1efc

Please sign in to comment.