Enhanced README Documentation - Githubissues

chirag-jn / notipyer

Notification Triggers for Python

https://pypi.org/project/notipyer/

GNU Affero General Public License v3.0

18 stars 2 forks source link

Enhanced README Documentation #20

Closed Vikranth3140 closed 3 weeks ago

Vikranth3140 commented 2 months ago

This PR addresses #4 to enhance the README documentation for the Notipyer project. It follows markdown-embed-code-from-file as mentioned in #4 issue.

The improvements include:

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.

These changes aim to provide a better user experience and make it easier for new users to get started with Notipyer.