Skip to content

Commit 3dfa8c7

Browse files
committed
update docs to reflect js config support
1 parent 5e2df32 commit 3dfa8c7

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

packages/launchpad/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ graph LR
3131
## Getting Started
3232

3333
1. Install launchpad: `npm i @bluecadet/launchpad`
34-
2. Create a `launchpad.json` config (see [configuration](#configuration))
34+
2. Create a `launchpad.config.js` config (see [configuration](#configuration))
3535
3. *Optional: [Bootstrap](/packages/scaffold) your PC with `npx launchpad scaffold`*
3636
4. Run `npx launchpad`
3737

@@ -43,10 +43,10 @@ Run `npx launchpad --help` to see all available commands.
4343

4444
## Configuration
4545

46-
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:
46+
Each [launchpad package](#packages) is configured via its own section in `launchpad.config.js`. 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:
4747

48-
```json
49-
{
48+
```js
49+
export default {
5050
"content": {
5151
"sources": [
5252
{
@@ -91,7 +91,7 @@ All available config settings across packages can be found in the links below:
9191

9292
### Config Loading
9393

94-
- By default, Launchpad looks for `launchpad.json` or `config.json` at the cwd (where you ran `npx launchpad`/`launchpad` from)
94+
- By default, Launchpad looks for `launchpad.config.js`, `launchpad.config.mjs`, `launchpad.json` or `config.json` at the cwd (where you ran `npx launchpad`/`launchpad` from)
9595
- You can change the default path with `--config=<YOUR_FILE_PATH>` (e.g. `npx launchpad --config=../settings/my-config.json`)
9696
- If no config is found, Launchpad will traverse up directories (up to 64) to find one
9797
- All config values can be overridden via `--foo=bar` (e.g. `--logging.level=debug`)

0 commit comments

Comments
 (0)