docs: enhanced readme with usage, FAQ, caveats, and hooks

Open ShriramNarkhede opened this issue 6 months ago • 3 comments

This pull request addresses Issue #63 by rewriting and expanding the README.md to improve developer onboarding and understanding of the plugin.

Jul 17 '25 13:07 ShriramNarkhede

Hi @pradeep910 👋

This PR improves the README as discussed in issue #63 by expanding on usage, caveats, worker threads, whitelisting, and FAQs.

All checks have passed ✅
Kindly review and let me know if any changes are needed. 🙏

Thanks!

Jul 17 '25 13:07 ShriramNarkhede

@ShriramNarkhede Thanks. Have we removed ## Does this interest you? part purposely?

Aug 07 '25 05:08 pradeep910

Thanks for pointing that out, @pradeep910 🙌 I’ve re-added the ## Does this interest you? section in the latest commit. Let me know if there’s anything else to address.

Aug 07 '25 07:08 ShriramNarkhede