docs: updated the readme

[billyjbryant]

📋 Description

• Streamlined the readme content to make it easier to follow

• Added logo

🎯 Type of Change

• 🐛 Bug fix (patch release)
• ✨ New feature (minor release)
• 💥 Breaking change (major release)
• 📚 Documentation update
• 🔧 Refactoring
• ⚡ Performance improvement
• ✅ Test changes
• 🏗️ Build/CI changes
• 🧹 Chore/maintenance

🚀 Release Impact

• Major (breaking changes) - BREAKING CHANGE: in commit message
• Minor (new features) - feat: commits
• Patch (bug fixes) - fix: commits
• None (docs, chore, etc.) - no release needed

📝 Commit Message Format

<type>(<scope>): <description>

[optional body]

[optional footer]

Examples:

• feat(bridge): add environment variable expansion
• fix(server): resolve connection timeout
• docs: update installation guide

✅ Checklist

Code Quality

• Code follows project style guidelines
• Self-review of code completed
• Comments added for complex logic
• No debugging code left in place

Testing

• New tests added for new functionality
• All existing tests pass
• Manual testing completed
• Edge cases considered

Documentation

• Documentation updated (if needed)
• Configuration examples updated (if needed)
• CHANGELOG impact considered
• Breaking changes documented

Commits

• Commits follow conventional format
• Commit messages are descriptive
• No merge commits in PR
• Squashed if multiple commits serve same purpose

🔗 Related Issues

Closes #
Relates to #

🧪 Testing

Test Environment

• Local development
• Docker container
• CI pipeline

Test Cases

• Test case 1
• Test case 2
• Test case 3

📸 Screenshots/Logs

⚠️ Breaking Changes

📋 Deployment Notes

👥 Reviewers

/cc @billyjbryant

[github-actions]

🔍 PR Validation Results

🟢 ✅ All validations passed!

📊 Validation Summary

Check	Status	Details
Release Labels	✅ Valid	release: skip
Type Labels	✅ Valid	type: documentation
Commit Format	✅ Valid	1/1 commits valid

🎉 Everything looks great!

• ✅ All required labels are present
• ✅ All commit messages follow conventional format
• ✅ Ready for review and merge

📚 Quick Reference Guide

Required Labels:

• Release Impact: release: major (breaking) | release: minor (features) | release: patch (fixes) | release: skip (no release)
• Change Type: type: feature | type: bug | type: documentation | type: refactor | type: test | type: chore

Conventional Commit Format:

<type>(<scope>): <description>

Examples:

• feat(bridge): add environment variable expansion
• fix(server): resolve connection timeout
• docs: update installation guide
• chore: update dependencies

Quick Fixes:

• Missing labels: Maintainers can add them, or request specific ones in comments
• Invalid commits: Use git rebase -i to edit commit messages
• Need help: Comment on this PR for assistance

---

Last updated: 2025-07-27T17:06:49.484Z • Workflow run

[github-actions]

🎉 This PR is included in version 1.1.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀