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.

Sign up for GitHub

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

Jump to bottom

Improve Readme #4

Open

chirag-jn opened this issue May 30, 2021 · 2 comments

Labels

documentation hacktoberfest

Owner

chirag-jn commented May 30, 2021

No description provided.

chirag-jn added the documentation label

Owner Author

chirag-jn commented Aug 27, 2021

Example code should be auto embedded in README. Example: https://github.com/marketplace/actions/markdown-embed-code-from-file

chirag-jn added the hacktoberfest label

Vikranth3140 mentioned this issue

Enhanced README Documentation #20

Closed

Vikranth3140 commented Jun 7, 2024

Hey @chirag-jn, I have enhanced the README to:

Added badges for the PyPI version and license.
Improved structure and clarity.
Detailed installation instructions.
Clear configuration and usage examples for email and Slack notifications.
Added sections for contributing, license, and contact information.

#20 PR proposes the Enhanced README

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment