Skip to content

Commit 84d0855

Browse files
committed
update docs
1 parent 46dfaec commit 84d0855

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<img src="media/demo.gif" alt="Flow Overview" width="88%" />
1010
</p>
1111

12-
## Features/Commands
12+
## Usage
1313

1414
Use our side bar or the **Command Palette** and type `Flow Scanner` to see the list of all available commands.
1515

@@ -18,15 +18,15 @@ Use our side bar or the **Command Palette** and type `Flow Scanner` to see the l
1818
* `Fix Flows` will apply available fixes automatically.
1919
* `Open Documentation` can be used to reference the documentation.
2020

21-
## Configuration Options
21+
## Configuration
2222

2323
| Key | Description | Default Value |
2424
| ----------------------------------------- | --------------------------------------------------------------------------------- | ------------------------------- |
2525
| `lightningFlowScanner.SpecifyFiles` | Specify flow file paths instead of a root directory. | `false` |
2626
| `lightningFlowScanner.NamingConvention` | Specify a REGEX expression to use as Flow Naming convention. | `"[A-Za-z0-9]+_[A-Za-z0-9]+"` |
2727
| `lightningFlowScanner.APIVersion` | Specify an expression to validate the API version, i.e. '===50'(use at least 50). | `">50"` |
2828

29-
## Development Setup
29+
## Development
3030

3131
1. Clone the repo:
3232

@@ -49,8 +49,8 @@ Use our side bar or the **Command Palette** and type `Flow Scanner` to see the l
4949
npm run build
5050
```
5151

52-
## This is a fork
52+
## Contributing
5353

5454
The original `lightning-flow-scanner-vsce` package was unpublished from the Visual Studio Marketplace after a Remote Code Execution (RCE) vulnerability was identified in its core dependency, `lightning-flow-scanner-core`. This issue, caused by unsafe custom rule loading, has been fully resolved in the [v5.1.0 release of the core library](https://github.com/Flow-Scanner/lightning-flow-scanner-core/releases/tag/v5.1.0). The [lightning-flow-scanner-vsx](https://github.com/Flow-Scanner/lightning-flow-scanner-vsx) fork, focusses on security and maintainability.
5555

56-
Want to help improve Lightning Flow Scanner? See our [Contributing Guidelines](https://github.com/Flow-Scanner/lightning-flow-scanner-core/blob/main/CONTRIBUTING.md).
56+
###### Want to help improve Lightning Flow Scanner? See our [Contributing Guidelines](https://github.com/Flow-Scanner/lightning-flow-scanner-core?tab=contributing-ov-file).

webviews/components/Banner.svelte

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<div class="banner">
33

44
<img
5-
src="https://raw.githubusercontent.com/Flow-Scanner/lightning-flow-scanner-core/main/files/media/bannerslim.png"
5+
src="https://raw.githubusercontent.com/Flow-Scanner/lightning-flow-scanner-core/main/assets/media/bannerslim.png"
66
alt="Lightning Flow Scanner banner"
77
/>
88
</div>

webviews/components/Navigation.svelte

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
<div class="banner">
4848
<a href="https://github.com/Lightning-Flow-Scanner">
4949
<img
50-
src="https://raw.githubusercontent.com/Flow-Scanner/lightning-flow-scanner-core/main/files/media/bannerslim.png"
50+
src="https://raw.githubusercontent.com/Flow-Scanner/lightning-flow-scanner-core/main/assets/media/bannerslim.png"
5151
alt="Lightning Flow Scanner banner"
5252
/>
5353
</a>

0 commit comments

Comments
 (0)