Skip to content

Commit 9f11e0b

Browse files
committed
update readme
1 parent f1916e0 commit 9f11e0b

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<p align="center">
22
<a href="https://github.com/Flow-Scanner">
3-
<img src="https://raw.githubusercontent.com/Flow-Scanner/lightning-flow-scanner-core/main/media/bannerslim.png" style="width: 41%;" />
3+
<img src="media/bannerslim.png" style="width: 41%;" />
44
</a>
55
</p>
66
<p align="center">Scans for unsafe contexts, hardcoded IDs, and other issues to optimize your Flows.</p>
77

88
![Demo GIF](media/lfsaction.gif)
99

10-
_[![GitHub Marketplace](https://img.shields.io/badge/GitHub%20Action-Lightning%20Flow%20Scanner-blue?logo=github)](https://github.com/marketplace/actions/run-flow-scanner) - For more information on the default rules and configurations available, please review the [Flow Scanner Documentation](https://flow-scanner.github.io/lightning-flow-scanner-core/)._
10+
_[![GitHub Marketplace](https://img.shields.io/badge/GitHub%20Action-Lightning%20Flow%20Scanner-blue?logo=github)](https://github.com/marketplace/actions/run-flow-scanner) - For more info on the rules and configurations, please review the [Scanner Documentation](https://flow-scanner.github.io/lightning-flow-scanner-core/)._
1111

1212
## Usage
1313

@@ -38,19 +38,17 @@ Also ensure the following:
3838
- Workflows have read and write permissions in the repository.
3939
- Allow GitHub Actions to create and approve pull requests.
4040

41-
### Automatically Runs On Pull Requests:
41+
### A) Automatically Runs On Pull Requests:
4242

4343
`on:pull_request` will trigger Flow Scanner to scan changed flow files every time a pull request is opened.
4444

45-
### Or Run It Manually:
45+
### B) Or Run It Manually:
4646

4747
`on:workflow_dispatch` allows you to run the action on all Flows manually, by following these steps:
4848
1. Navigate to the "Actions" tab of your GitHub repository.
4949
2. Click on "Run Flow Scanner" in the list of available workflows.
5050
3. Press the "Run workflow" button to trigger the action.
5151

52-
---
53-
5452
## Configuration
5553

5654
Flow Scanner can be configured and the action will look for a .flow-scanner file in your repository root, such as:
@@ -76,12 +74,12 @@ For example:
7674
7775
If no configurations are found, the scanner falls back to the default rules/threshold.
7876
79-
## Development Setup
77+
## Development
8078
8179
To debug the action locally you need to ensure you have `npm` and `act` installed and follow these steps:
8280
8381
1. Run `npm run build` to compile a new version
8482
2. Run act: Use the act command to run the workflow:
8583
`act workflow_dispatch --secret-file .secrets`
8684
87-
If you'd like to help us enhance Flow Scanner, please consider having a look at the [Contributing Guidelines](https://github.com/Flow-Scanner/lightning-flow-scanner-core/blob/main/CONTRIBUTING.md).
85+
Want to help improve Lightning Flow Scanner? See our [Contributing Guidelines](https://github.com/Flow-Scanner/lightning-flow-scanner-core/blob/main/CONTRIBUTING.md).

0 commit comments

Comments
 (0)