Skip to content

Commit 5f2a483

Browse files
committed
update docs
1 parent 5c2e7bb commit 5f2a483

File tree

1 file changed

+10
-15
lines changed

1 file changed

+10
-15
lines changed

README.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1-
[![Lightning Flow Scanner](media/banner.png)](https://github.com/Lightning-Flow-Scanner)
1+
<p align="center">
2+
<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: 55%;" />
4+
</a>
5+
</p>
6+
<p align="center">Scans for unsafe contexts, hardcoded IDs, and other issues to optimize your Flows.</p>
27

3-
[![Demo](media/lfsapp.gif)](https://github.com/Lightning-Flow-Scanner)
8+
[![Demo](media/lfsapp.gif)](https://github.com/Lightning-Flow-Scanner)
49

5-
#### Pinpoint deviations from Industry Best Practices in Salesforce Flows and ensure standards of business automation excellence.
10+
## Installation
611

7-
## Features
812

9-
- **Flow Overview**: Displays a list of all flows in your Salesforce org and allows users to scan the metadata of a selected flow.
10-
- **Flow Analysis**: Provides detailed metadata analysis of the selected flow.
1113

1214
## Using the Lightning Flow Scanner
1315

@@ -19,15 +21,6 @@
1921
2) Scan a Flow:
2022
- To scan a flow, click the "Scan" button next to the flow you want to analyze.
2123

22-
## Project Structure
23-
24-
The project is organized into two main directories:
25-
26-
1) force-app: The main application(tab, page etc)
27-
2) lfs_component: Contains the Lightning Flow Scanner Component, used by the main application.
28-
29-
This structure allows for clear separation of the core scanning functionality and the main application logic. By modularizing the core scanning functionality, we ensure easier maintenance and updates. Additionally, this setup encourages other Salesforce apps to integrate our functionality, promoting collaboration and expanding the potential use cases for the Lightning Flow Scanner.
30-
3124
## Development
3225

3326
### Development Flow
@@ -58,3 +51,5 @@ sfdx force:source:push
5851
```sh
5952
sfdx force:source:pull
6053
```
54+
55+
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).

0 commit comments

Comments
 (0)