Featute/update readme

[manikanta-sadurla]

update readme

[github-advanced-security]

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

• The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
• Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
• You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

[sonarqubecloud]

SonarQube reviewer guide

Summary: Remove Snyk security scanning workflow and policy file, update .gitignore, and significantly expand README documentation with module metadata, quickstart guide, and input/output reference tables.

Review Focus: Verify that removing the Snyk workflow and .snyk policy file aligns with the team's security strategy—ensure vulnerability scanning hasn't been migrated elsewhere or is no longer required. Review README changes for accuracy of the new module metadata and example code.

Start review at: .github/workflows/snyk.yaml and .snyk (deleted files). Understanding why security scanning is being removed is critical before approving, as this represents a change in your security posture.

💬 Please send your feedback

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[vijay-stephen]

LGTM