Skip to content

Commit 552e991

Browse files
committed
Minor readme revisions
1 parent 4b7ea28 commit 552e991

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

packages/launchpad/README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,18 @@ Launchpad is a highly configurable suite of tools to manage media installations.
1313

1414
## Getting Started
1515

16-
A typical setup will use launchpad as a node dependency, configure it via a `launchpad.json` file and run `npx launchpad` via a startup task (e.g. Windows Task Scheduler):
16+
1. Install launchpad: `npm i @bluecadet/launchpad`
17+
2. Create a `launchpad.json` config (see [configuration](#configuration))
18+
3. *Optional: [Bootstrap](/packages/scaffold) your PC with `npx launchpad scaffold`*
19+
4. Run `npx launchpad`
1720

18-
1. Install launchpad: **`npm i @bluecadet/launchpad`**
19-
2. Create a **`launchpad.json`** config (see [configuration](#configuration))
20-
3. *Optional: Bootstrap your PC with `npx launchpad scaffold`*
21-
4. Run **`npx launchpad`**
21+
Run `npx launchpad --help` to see all available commands.
2222

23-
Type `npx launchpad --help` for all available commands.
24-
25-
*Launchpad can also be installed globally via `npm i -g @bluecadet/launchpad` and called via `launchpad` instead of `npx launchpad`.*
23+
Note: Launchpad is typically installed as a local dependency, configured with a `launchpad.json` file and run by a startup task (e.g. Windows Task Scheduler) using `npx launchpad`. Launchpad can also be installed globally via `npm i -g @bluecadet/launchpad` and called via `launchpad` instead of `npx launchpad`.
2624

2725
## Configuration
2826

29-
Each [launchpad package](#packages) is configured via its own section in `launchpad.json`. Below is a simple example that uses the [`content`](/packages/content) package to download JSON and images from Flickr and the [`monitor`](/packages/monitor) to launch a single app:
27+
Each [launchpad package](#packages) is configured via its own section in `launchpad.json`. Below is a simple example that uses the [`content`](/packages/content) package to download JSON and images from Flickr and [`monitor`](/packages/monitor) to launch a single app:
3028

3129
```json
3230
{

0 commit comments

Comments
 (0)