Skip to content

Commit

Permalink
Enhance "Installation" section in README
Browse files Browse the repository at this point in the history
  • Loading branch information
paescuj authored Nov 18, 2022
1 parent 7b427d6 commit c315a42
Showing 1 changed file with 9 additions and 12 deletions.
21 changes: 9 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Like `npm run watch-js & npm run watch-less` but better.

- [concurrently](#concurrently)
- [Why](#why)
- [Install](#install)
- [Installation](#installation)
- [Usage](#usage)
- [API](#api)
- [`concurrently(commands[, options])`](#concurrentlycommands-options)
Expand All @@ -41,25 +41,22 @@ tired of opening terminals and made **concurrently**.
- With `--kill-others` switch, all commands are killed if one dies
- Spawns commands with [spawn-command](https://github.com/mmalecki/spawn-command)

## Install
## Installation

The tool is written in Node.js, but you can use it to run **any** commands.
**concurrently** can be installed in the global scope (if you'd like to have it available and use it on the whole system) or locally for a specific package (for example if you'd like to use it in the `scripts` section of your package):

```bash
npm install -g concurrently
```

or if you are using it from npm scripts:

```bash
npm install concurrently --save-dev
```
| | npm | Yarn | pnpm |
| ---------- | ----------------------- | ------------------------------ | -------------------------- |
| **Global** | `npm i -g concurrently` | `yarn global add concurrently` | `pnpm add -g concurrently` |
| **Local** | `npm i concurrently -D` | `yarn add concurrently -D` | `pnpm add -D concurrently` |

## Usage

> **Note**
> The `concurrently` command is now also available under the shorthand alias `conc`.
The tool is written in Node.js, but you can use it to run **any** commands.

Remember to surround separate commands with quotes:

```bash
Expand Down

0 comments on commit c315a42

Please sign in to comment.