docs(core): readme update

[vinaygupta-sourcefuse]

Description

readme updated

Checklist:

• Performed a self-review of my own code
• npm test passes on your machine
• New tests added or existing tests modified to cover all changes
• Code conforms with the style guide
• API Documentation in code was updated
• Any dependent changes have been merged and published in downstream modules

[sonarqubecloud]

SonarQube reviewer guide

Summary: Significant documentation cleanup removing extensive code examples, troubleshooting guides, and advanced feature sections from README.md while retaining core setup instructions.

Review Focus: This is a large documentation reduction (370+ lines removed). Verify that:

• No critical setup or usage information was inadvertently removed
• The retained examples are still sufficient for users to get started
• Whether removed sections (troubleshooting, best practices, advanced features) should be preserved or moved elsewhere
• If this cleanup aligns with a documentation restructuring strategy

Start review at: README.md. This is the only file changed, and the extent of removals (detailed examples, troubleshooting guide, best practices, advanced features) warrants careful review to ensure essential user-facing documentation remains adequate.

💬 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

[yeshamavani]

🎉 This PR is included in version 1.0.3 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀