File tree Expand file tree Collapse file tree 1 file changed +27
-2
lines changed Expand file tree Collapse file tree 1 file changed +27
-2
lines changed Original file line number Diff line number Diff line change 1212 - [ Configuring Expressions] ( #configuring-expressions )
1313 - [ Specifying Exceptions] ( #specifying-exceptions )
1414 - [ Include Beta Rules] ( #include-beta-rules )
15- - [ Core Functions] ( #core-functions )
15+ - [ Usage] ( #installation )
16+ - [ Install As Dependency] ( #install-as-dependency )
17+ - [ Core Functions] ( #core-functions )
18+ - [ UMD Module] ( #umd-module )
1619- [ Development] ( #development )
1720
1821---
@@ -221,7 +224,21 @@ New rules are introduced in Beta mode before being added to the default ruleset.
221224}
222225```
223226
224- ## Core Functions
227+ ---
228+
229+ ## Usage
230+
231+ The Lightning Flow Scanner Core can be used as a dependency in Node.js and browser environments, or as a standalone UMD module.
232+
233+ ### Install As Dependency
234+
235+ To install the module as a dependency run:
236+
237+ ``` bash
238+ npm install @flow-scanner/lightning-flow-scanner-core
239+ ```
240+
241+ ### Core Functions
225242
226243### [ ` getRules(ruleNames?: string[]): IRuleDefinition[] ` ] ( https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/libs/GetRuleDefinitions.ts )
227244
@@ -239,6 +256,14 @@ _Runs rules against parsed flows and returns scan results._
239256
240257_ Attempts to apply automatic fixes where available._
241258
259+ ### UMD Module
260+
261+ To create a standalone UMD module, follow the [ development insructions] ( #development ) and run:
262+
263+ ``` bash
264+ npm run vite:dist
265+ ```
266+
242267---
243268
244269## Development
You can’t perform that action at this time.
0 commit comments