Skip to content

Commit 13209d1

Browse files
committed
update documentation
1 parent f5d474e commit 13209d1

File tree

3 files changed

+9
-10
lines changed

3 files changed

+9
-10
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
## Contributing Guidelines
22

3-
### Our Journey: Shaping Flow Analysis Since 2021
4-
5-
Since 2021, the _Lightning Flow Scanner_ has grown from its roots in CLI and VS Code tools to empower Salesforce Developers across six free and open-source platforms—from CLI tools to native Salesforce apps—delivering a unified experience for robust static analysis of Flows. Our dedicated community has shared their expertise to deepen understanding of Flow optimization. Your support can amplify our impact. Here’s how you can contribute:
3+
Since 2021, the _Lightning Flow Scanner_ has grown from its roots as VS Code tool to empower Salesforce Developers across six free and open-source platforms—from developer tools to native Salesforce App—delivering a unified experience for robust static analysis of Flows. Our dedicated community has shared their expertise to deepen understanding of Flow optimization. Your support can amplify our impact. Here’s how you can contribute:
64

75
- ⭐ Starring the project to show your support
86
- 📢 Sharing our work with your network

SECURITY.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,17 @@
55
- Code is open-source and peer-reviewed by the community.
66
- Vulnerabilities can be reported privately via GitHub security features.
77
- Changes to the repository are scanned and reviewed before merging.
8+
- Tokenless Publishing with scoped npm packages and releases via GitHub Actions Trusted Publishing (OIDC).
89

910
## Reporting a Vulnerability
1011

1112
If you discover a security vulnerability, please report it using [GitHub vulnerability reporting](https://github.com/Flow-Scanner/lightning-flow-scanner-core/security).
1213

1314
## Data Handling
1415

15-
This project collects zero user data. No credentials, PII, payment info, or health data is ever stored, transmitted, or shared. All analysis runs 100% client-side with no network calls to any external services.
16+
This tool collects zero user data. No credentials, PII, payment info, health data, or user content is ever stored, transmitted, or shared. All analysis runs 100% client-side with no network calls to external services.
17+
18+
We temporarily use metadata (e.g., Flow metadata, timestamps) in-memory only for real-time functionality during your session. This data is never stored, logged, or transmitted and is discarded immediately when the session ends.
1619

1720
## Dependencies
1821

readme.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
- [Configuring Expressions](#configuring-expressions)
1313
- [Specifying Exceptions](#specifying-exceptions)
1414
- [Include Beta Rules](#include-beta-rules)
15-
- [Usage](#installation)
16-
- [Install As Dependency](#install-as-dependency)
15+
- [Usage](#Usage)
16+
- [Installation](#installation)
1717
- [Core Functions](#core-functions)
1818
- [Development](#development)
1919

@@ -226,11 +226,9 @@ New rules are introduced in Beta mode before being added to the default ruleset.
226226

227227
## Usage
228228

229-
The Lightning Flow Scanner Core can be used as a dependency in Node.js and browser environments, or as a standalone UMD module.
229+
### Installation
230230

231-
### Install As Dependency
232-
233-
To install the module as a dependency run:
231+
The Lightning Flow Scanner Core can be used as a dependency in Node.js and browser environments, or used as a standalone UMD module. To install:
234232

235233
```bash
236234
npm install @flow-scanner/lightning-flow-scanner-core

0 commit comments

Comments
 (0)