Skip to content

Commit 6caf31e

Browse files
committed
update docs
1 parent d1ef86b commit 6caf31e

File tree

4 files changed

+11
-10
lines changed

4 files changed

+11
-10
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@ parse("flows/*.xml").then(scan).then(exportSarif);
349349

350350
## Development
351351

352-
> This project optionally uses [Volta](https://volta.sh) to manage Node.js versions. Install Volta with:
352+
> This project optionally uses [Volta](https://volta.sh) to manage Node.js and PNPM versions. Install Volta with:
353353
>
354354
> ```sh
355355
> curl https://get.volta.sh | bash
@@ -399,13 +399,13 @@ parse("flows/*.xml").then(scan).then(exportSarif);
399399
pnpm link --global @flow-scanner/lightning-flow-scanner-core
400400
```
401401

402-
a. You can now do Ad-Hoc Testing with node:
402+
You can now do Ad-Hoc Testing with node:
403403

404404
```bash
405405
node -i -e "import('@flow-scanner/lightning-flow-scanner-core').then(m => { Object.assign(global, m.default ? m.default : m); console.log('✅ Core loaded! Try: await parse(...), scan(...), etc.'); })"
406406
```
407407

408-
b. Or test in a dependent project:
408+
Or test in a dependent project:
409409

410410
```bash
411411
npm link @flow-scanner/lightning-flow-scanner-core
@@ -414,15 +414,15 @@ parse("flows/*.xml").then(scan).then(exportSarif);
414414
6. Deploy Demo Flows (Optional):
415415

416416
```bash
417-
cd assets/example-flows && sf project deploy start &&
417+
cd assets/example-flows && sf project deploy start
418418
```
419419

420420
Navigate to the [Demo Readme](assets\example-flows\README.md) for full details
421421

422422
7. Create a standalone UMD Module(Optional):
423423

424424
```bash
425-
npm run vite:dist // creates UMD at`dist/lightning-flow-scanner-core.umd.js`.
425+
pnpm dist // creates UMD at`dist/lightning-flow-scanner-core.umd.js`.
426426
```
427427

428428
<p><strong>Want to help improve Lightning Flow Scanner? See our <a href="https://github.com/Flow-Scanner/lightning-flow-scanner?tab=contributing-ov-file">Contributing Guidelines</a></strong></p>

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
"build": "turbo run build",
88
"build:core": "pnpm turbo run build --filter=@flow-scanner/lightning-flow-scanner-core",
99
"build:cli": "pnpm turbo run build --filter=lightning-flow-scanner",
10+
"build:docs": "node scripts/update-package-readmes.js",
1011
"test": "turbo run test",
1112
"test:core": "turbo run test --filter=@flow-scanner/lightning-flow-scanner-core",
1213
"test:cli": "turbo run test --filter=lightning-flow-scanner",

packages/cli/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ npm install -g lightning-flow-scanner
317317

318318
## Development
319319

320-
> This project optionally uses [Volta](https://volta.sh) to manage Node.js versions. Install Volta with:
320+
> This project optionally uses [Volta](https://volta.sh) to manage Node.js and PNPM versions. Install Volta with:
321321
>
322322
> ```sh
323323
> curl https://get.volta.sh | bash
@@ -367,13 +367,13 @@ npm install -g lightning-flow-scanner
367367
pnpm link --global @flow-scanner/lightning-flow-scanner-core
368368
```
369369

370-
a. You can now do Ad-Hoc Testing with node:
370+
You can now do Ad-Hoc Testing with node:
371371

372372
```bash
373373
node -i -e "import('@flow-scanner/lightning-flow-scanner-core').then(m => { Object.assign(global, m.default ? m.default : m); console.log('✅ Core loaded! Try: await parse(...), scan(...), etc.'); })"
374374
```
375375

376-
b. Or test in a dependent project:
376+
Or test in a dependent project:
377377

378378
```bash
379379
npm link @flow-scanner/lightning-flow-scanner-core
@@ -382,15 +382,15 @@ npm install -g lightning-flow-scanner
382382
6. Deploy Demo Flows (Optional):
383383

384384
```bash
385-
cd assets/example-flows && sf project deploy start &&
385+
cd assets/example-flows && sf project deploy start
386386
```
387387

388388
Navigate to the [Demo Readme](assets\example-flows\README.md) for full details
389389

390390
7. Create a standalone UMD Module(Optional):
391391

392392
```bash
393-
npm run vite:dist // creates UMD at`dist/lightning-flow-scanner-core.umd.js`.
393+
pnpm dist // creates UMD at`dist/lightning-flow-scanner-core.umd.js`.
394394
```
395395

396396
<p><strong>Want to help improve Lightning Flow Scanner? See our <a href="https://github.com/Flow-Scanner/lightning-flow-scanner?tab=contributing-ov-file">Contributing Guidelines</a></strong></p>
File renamed without changes.

0 commit comments

Comments
 (0)