updated readme

[christianchimezie]

Pull Request

Description

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update
• Code refactoring (no functional changes)
• Performance improvement
• Test additions/improvements
• CI/CD changes
• Dependencies update

Related Issues

Closes #
Related to #

Changes Made

Documentation

• I have updated the README.md (if needed)
• I have updated TESTING.md (if test-related changes)
• I have added/updated docstrings for new functions/classes
• I have updated type hints/annotations
• I have added comments for complex logic

Checklist

• I have read the CONTRIBUTING guidelines
• My branch is up to date with the target branch
• I have resolved all merge conflicts
• All CI/CD checks pass
• Code has been reviewed by me
• I have tested this on my local environment
• Documentation is updated
• Commit messages follow Conventional Commits