Skip to content

Commit

Permalink
docs(readme): 📝 shortened the description about installation process
Browse files Browse the repository at this point in the history
  • Loading branch information
dipiash committed Nov 2, 2023
1 parent 8a6c797 commit f8f8262
Showing 1 changed file with 15 additions and 62 deletions.
77 changes: 15 additions & 62 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,6 @@ A comprehensive linting solution that sweeps your code clean. Fly through your c
<!-- toc -->

- [Installation](#installation)
* [Via npm](#via-npm)
* [Via yarn](#via-yarn)
* [Via pnpm](#via-pnpm)
- [Usage](#usage)
- [License](#license)
- [Contributions](#contributions)
Expand All @@ -24,89 +21,45 @@ A comprehensive linting solution that sweeps your code clean. Fly through your c

Here you can find instructions how to install it via: `npm`, `yarn`, `pnpm`.

#### Via npm

You'll first need to install [ESLint](https://eslint.org/) and TypeScript:

```sh
npm i eslint --save-dev
npm i typescript
```

Next, install `eslint-plugin-nimbus-clean`:

```sh
npm install eslint-plugin-nimbus-clean --save-dev
```

Next, install all peerDependencies for this plugin:

```sh
npx install-peerdeps eslint-plugin-nimbus-clean
```

Next refer to [Usage](#usage) section.

#### Via yarn

Install `yarn` globally if you haven't already:

```sh
npm install -g yarn
```

Next install [ESLint](https://eslint.org/) and TypeScript:

```sh
# Or run this to use yarn
yarn add eslint --dev
yarn add typescript
```

Next install `eslint-plugin-nimbus-clean`:

```sh
yarn add eslint-plugin-nimbus-clean --dev
```

Next install all peerDependencies for this plugin:

```sh
npx install-peerdeps eslint-plugin-nimbus-clean --yarn
```

Next refer to [Usage](#usage) section.

#### Via pnpm

Install `pnpm` globally if you haven't already:

```sh
npm install -g pnpm
# Or using yarn
yarn global add pnpm
```

Next install [ESLint](https://eslint.org/) and TypeScript:

```sh
# Or run this to use pnpm
pnpm add eslint --save-dev
pnpm add typescript
```

Next, install `eslint-plugin-nimbus-clean`:

```sh
npm install eslint-plugin-nimbus-clean --save-dev

# Or run this to use yarn
yarn add eslint-plugin-nimbus-clean --dev

# Or run this to use pnpm
pnpm add eslint-plugin-nimbus-clean --save-dev
```

Next install all peerDependencies for this plugin:
Next, install all peerDependencies for this plugin:

```sh
npx install-peerdeps eslint-plugin-nimbus-clean

# Or run this to use yarn
npx install-peerdeps eslint-plugin-nimbus-clean --yarn

# Or run this to use pnpm
npx install-peerdeps eslint-plugin-nimbus-clean --pnpm
```

Next refer to [Usage](#usage) section.

### Usage

1. Add `nimbus-clean` to the extends or plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
Expand Down

0 comments on commit f8f8262

Please sign in to comment.