Skip to content
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

FEAT: Add details to the README.md file #46

Merged
merged 1 commit into from
May 2, 2023
Merged

Conversation

HenryAsa
Copy link
Owner

@HenryAsa HenryAsa commented May 2, 2023

Pull Request Template

Description

I updated the README.md file to include more details and intended changes to the repository. While it still needs work and needs to be elaborated on, this is a good start. I still need to include example files on how to use the email-rules package as well as instructions on how to upload the .xml files to each respective email client.

Related Issues

Related to #45
Fixes #(issue)

Type of Change

  • Documentation (added documentation or related to docs)

How Has This Been Tested?

Does not need testing.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

@HenryAsa HenryAsa self-assigned this May 2, 2023
@HenryAsa HenryAsa merged commit b27057e into main May 2, 2023
@HenryAsa HenryAsa deleted the feature/improve_readme branch May 2, 2023 22:07
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.

DOC: Edit README.md to be more detailed and include link to GitHub hosted docs.
1 participant