rsnext/examples/with-eslint
Apurv Chimralwar 429f63dd76
Fix Typo in "with-eslint" Example docs (#28601)
Earlier it was:

```bash
npx create-next-app --example with-eslint with-eslint
# or
yarn create next-app --example with-eslint with-eslint
```

It was confusing for me, 
as i couldn't identify which one is *example-name* and which one is *folder-name* (for *with-eslint*).

I checked other example folders and was able to digest the stuff.
But if a new programmer comes who is not familiar with next/npx,
this could have took some time to understand.

And Hence i modified the cmd it to  the below, for better understanding:

```bash
npx create-next-app --example with-eslint with-eslint-app
# or
yarn create next-app --example with-eslint with-eslint-app
```

## Documentation / Examples

- [X] Make sure the linting passes
2021-09-07 16:36:54 +00:00
..
pages Adds ESLint with default rule-set (#23702) 2021-04-30 11:09:07 +00:00
.eslintrc Adds ESLint with default rule-set (#23702) 2021-04-30 11:09:07 +00:00
.gitignore Adds ESLint with default rule-set (#23702) 2021-04-30 11:09:07 +00:00
package.json Clean up examples package.json (#27121) 2021-07-12 19:58:03 +00:00
README.md Fix Typo in "with-eslint" Example docs (#28601) 2021-09-07 16:36:54 +00:00

ESLint Example

This example shows a Next.js application using the built-in ESLint setup with the next shareable configuration enabled in .eslintrc.

Learn more about the integrated ESLint configuration in the docs.

Preview

Preview the example live on StackBlitz:

Open in StackBlitz

Deploy your own

Deploy the example using Vercel:

Deploy with Vercel

How to use

Execute create-next-app with npm or Yarn to bootstrap the example:

npx create-next-app --example with-eslint with-eslint-app
# or
yarn create next-app --example with-eslint with-eslint-app

Deploy it to the cloud with Vercel (Documentation).