Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ShriramNarkhede
Copy link

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

@ShriramNarkhede
Copy link
Author

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!

@pradeep910
Copy link
Collaborator

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

@ShriramNarkhede
Copy link
Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants