logicspark/berryjam

[docs]: Add documentation for scan options in welcome.md

ravut8 opened this issue · 0 comments

ravut8 commented

Overview

The new scanned options for the VueScanner class method not yet documented so users may not know they are available. Here are the 3 added options

  1. verbose - to provide detailed scanning log from the console
  2. ignore - to allow users to specify file paths and/or directories to be excluded from scanning
  3. output - by default, the scan will output the component profiles in JSON format. Another export format is STDOUT.

Expected Behavior

  • Add explanations for VueScannerOption Interface and OutputFormat Type before the 5-step section.