Skip to content

Commit c315a42

Browse files
authored
Enhance "Installation" section in README
1 parent 7b427d6 commit c315a42

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

README.md

+9-12
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Like `npm run watch-js & npm run watch-less` but better.
1515

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

44-
## Install
44+
## Installation
4545

46-
The tool is written in Node.js, but you can use it to run **any** commands.
46+
**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):
4747

48-
```bash
49-
npm install -g concurrently
50-
```
51-
52-
or if you are using it from npm scripts:
53-
54-
```bash
55-
npm install concurrently --save-dev
56-
```
48+
| | npm | Yarn | pnpm |
49+
| ---------- | ----------------------- | ------------------------------ | -------------------------- |
50+
| **Global** | `npm i -g concurrently` | `yarn global add concurrently` | `pnpm add -g concurrently` |
51+
| **Local** | `npm i concurrently -D` | `yarn add concurrently -D` | `pnpm add -D concurrently` |
5752

5853
## Usage
5954

6055
> **Note**
6156
> The `concurrently` command is now also available under the shorthand alias `conc`.
6257
58+
The tool is written in Node.js, but you can use it to run **any** commands.
59+
6360
Remember to surround separate commands with quotes:
6461

6562
```bash

0 commit comments

Comments
 (0)