chore: update documentation and enhance performance details

- Revised CHANGELOG to reflect performance improvements and enhanced error handling
- Updated README for better clarity and organization, including key features and installation instructions
- Minor adjustments to CONTRIBUTING guidelines for consistency

Author: SirStig

CHANGELOG.md

@@ -8,36 +8,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added
-- N/A
 
-### Changed
-- N/A
+- Performance improvements and optimization features
 
-### Deprecated
-- N/A
+### Changed
 
-### Removed
-- N/A
+- Enhanced error handling and logging capabilities
 
 ### Fixed
-- N/A
 
-### Security
-- N/A
+- Minor bug fixes and stability improvements
 
 ## [0.1.3] - 2025-08-22
 
 ### Added
+
 - CLI module execution support via `python -m yokedcache`
 - Full CLI command suite: ping, stats, list, flush, search, export-config, warm
 - Comprehensive documentation updates with accurate CLI examples
 
 ### Changed
+
 - Improved CLI architecture with proper command registration
 - Enhanced GitHub Actions workflow for better CI/CD reliability
 - Updated all documentation files for accuracy and completeness
 
 ### Fixed
+
 - Redis connection method: changed from `aclose()` to `close()` for proper async connection handling
 - CLI command registration issue with async decorators using `functools.wraps`
 - CLI parameter conflict with double context passing in async commands
@@ -47,11 +44,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - GitHub Actions integration test failures with CLI module execution
 
 ### Removed
+
 - Codecov integration temporarily disabled due to rate limiting issues
 
 ## [0.1.2] - 2025-08-22
 
 ### Added
+
 - Initial project structure and core architecture
 - Basic caching functionality with Redis backend
 - Automatic cache invalidation on database writes
@@ -74,6 +73,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.1.0] - 2024-MM-DD
 
 ### Added
+
 - Initial release of YokedCache
 - Core caching functionality with Redis
 - FastAPI integration support

CONTRIBUTING.md

@@ -232,4 +232,4 @@ Contributors will be recognized in:
 - Release notes
 - The CONTRIBUTORS file
 
-Thank you for contributing to YokedCache! 🚀
+Thank you for contributing to YokedCache!

README.md

@@ -1,35 +1,46 @@
-<div align="center">
+# YokedCache
 
-# 🚀 YokedCache
-
-**High-Performance Caching for Modern Python Applications**
+High-Performance Caching for Modern Python Applications
 
 [![PyPI version](https://img.shields.io/pypi/v/yokedcache.svg)](https://pypi.org/project/yokedcache/)
 [![Python](https://img.shields.io/pypi/pyversions/yokedcache.svg)](https://pypi.org/project/yokedcache/)
 [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 [![Tests](https://github.com/sirstig/yokedcache/actions/workflows/test.yml/badge.svg)](https://github.com/sirstig/yokedcache/actions/workflows/test.yml)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![PyPI - Downloads](https://img.shields.io/pypi/dm/yokedcache)](https://pypi.org/project/yokedcache/)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/yokedcache)
+
+Intelligent caching with automatic invalidation, fuzzy search, and seamless FastAPI integration.
 
-*Intelligent caching with automatic invalidation, fuzzy search, and seamless FastAPI integration*
+**[Documentation](https://sirstig.github.io/yokedcache)** | **[Report Bug](https://github.com/sirstig/yokedcache/issues)** | **[Request Feature](https://github.com/sirstig/yokedcache/issues)**
 
-[📚 Documentation](https://sirstig.github.io/yokedcache) • [🐛 Report Bug](https://github.com/sirstig/yokedcache/issues) • [✨ Request Feature](https://github.com/sirstig/yokedcache/issues)
+## Table of Contents
 
-</div>
+- [Overview](#overview)
+- [Key Features](#key-features)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Documentation](#documentation)
+- [Usage Examples](#usage-examples)
+- [CLI Usage](#cli-usage)
+- [Performance](#performance)
+- [Architecture](#architecture)
+- [Testing](#testing)
+- [Contributing](#contributing)
+- [License](#license)
 
 ---
 
-## 🎯 **Why YokedCache?**
+## Overview
 
-Traditional caching solutions require manual cache management and lack intelligent invalidation. **YokedCache** solves this with:
+Traditional caching solutions require manual cache management and lack intelligent invalidation. YokedCache solves this with:
 
-🔄 **Smart Auto-Invalidation** - Automatically detects database changes and invalidates related caches  
-⚡ **Zero-Code Integration** - Drop-in replacement for your existing database dependencies  
-🎯 **Intelligent Tagging** - Group and invalidate related caches effortlessly  
-🔍 **Fuzzy Search** - Find cached data with approximate matching  
-📊 **Performance Insights** - Built-in metrics and monitoring tools
+- **Smart Auto-Invalidation**: Automatically detects database changes and invalidates related caches
+- **Zero-Code Integration**: Drop-in replacement for your existing database dependencies  
+- **Intelligent Tagging**: Group and invalidate related caches effortlessly  
+- **Fuzzy Search**: Find cached data with approximate matching  
+- **Performance Insights**: Built-in metrics and monitoring tools
 
-## ⚡ **Quick Start**
+## Quick Start
 
 ```bash
 pip install yokedcache
@@ -50,72 +61,61 @@ async def get_user(user_id: int, db=Depends(cached_get_db)):
     return db.query(User).filter(User.id == user_id).first()
 ```
 
-**That's it!** Your database queries are now cached with automatic invalidation. 🎉
+That's it! Your database queries are now cached with automatic invalidation.
 
-## ✨ **Features**
+## Key Features
 
-<table>
-<tr>
-<td width="50%">
+### Smart Invalidation
 
-### 🔄 **Smart Invalidation**
 - Automatic cache invalidation on database writes
 - Tag-based grouping for related data
 - Pattern-based invalidation with wildcards
 - Configurable rules per table/operation
 
-### 🎯 **Deep Integration** 
+### Deep Integration
+
 - Zero-code FastAPI integration
 - SQLAlchemy ORM support
 - Async/await throughout
 - Connection pooling & health checks
 
-</td>
-<td width="50%">
+### Advanced Features
 
-### 🔍 **Advanced Features**
 - Fuzzy search for approximate matches
 - Multiple serialization methods
 - Performance metrics & monitoring
 - Variable TTLs with jitter
 
-### 🖥️ **Management Tools**
+### Management Tools
+
 - Comprehensive CLI for cache control
 - Real-time statistics and monitoring
 - YAML-based configuration
 - Cache warming capabilities
 
-</td>
-</tr>
-</table>
-
-## 📦 **Installation**
+## Installation
 
 ```bash
-# 🚀 Basic installation
+# Basic installation
 pip install yokedcache
 
-# 🔧 With optional features
+# With optional features
 pip install yokedcache[sqlalchemy,fuzzy]  # Full-featured
 
-# 👨‍💻 Development
+# Development
 pip install yokedcache[dev]
 ```
 
-## 📖 **Documentation**
-
-<div align="center">
-
-| 📚 **Guide** | 🔗 **Link** | 📝 **Description** |
-|-------------|------------|-------------------|
-| **Quick Start** | [Getting Started](#-quick-start) | 5-minute integration guide |
-| **API Reference** | [Docs](https://sirstig.github.io/yokedcache) | Complete API documentation |
-| **Examples** | [Examples](examples/) | Real-world usage examples |
-| **CLI Guide** | [CLI Usage](#-cli-usage) | Command-line tool documentation |
+## Documentation
 
-</div>
+| Guide | Link | Description |
+|-------|------|-------------|
+| Quick Start | [Getting Started](#quick-start) | 5-minute integration guide |
+| API Reference | [Documentation](https://sirstig.github.io/yokedcache) | Complete API documentation |
+| Examples | [Examples](examples/) | Real-world usage examples |
+| CLI Guide | [CLI Usage](#cli-usage) | Command-line tool documentation |
 
-## 🎬 **Live Demo**
+## Usage Examples
 
 ```python
 from fastapi import FastAPI, Depends
@@ -124,18 +124,18 @@ from yokedcache import YokedCache, cached_dependency
 app = FastAPI()
 cache = YokedCache(redis_url="redis://localhost:6379/0")
 
-# 1️⃣ Wrap your existing database dependency
+# Wrap your existing database dependency
 cached_get_db = cached_dependency(get_db, cache=cache, ttl=300)
 
 @app.get("/users/{user_id}")
 async def get_user(user_id: int, db=Depends(cached_get_db)):
-    # 2️⃣ Your existing code works unchanged!
+    # Your existing code works unchanged!
     return db.query(User).filter(User.id == user_id).first()
 
-# 🎉 Automatic caching + invalidation now active!
+# Automatic caching + invalidation now active!
 ```
 
-## 🔧 **Advanced Usage**
+### Advanced Usage
 
 ### Configuration with YAML
 
@@ -169,7 +169,7 @@ data = await cache.get("key")
 await cache.invalidate_tags(["products"])
 ```
 
-## 🖥️ **CLI Usage**
+## CLI Usage
 
 YokedCache includes a powerful CLI for cache management:
 
@@ -199,20 +199,16 @@ yokedcache export-config --output config.yaml
 yokedcache warm --config-file cache_config.yaml
 ```
 
-## 🚀 **Performance**
+## Performance
 
-<div align="center">
+| Metric | Improvement | Description |
+|--------|-------------|-------------|
+| Database Load | 60-90% reduction | Automatic query caching |
+| Response Time | 200-500ms faster | Redis-fast cache hits |
+| Memory Usage | Optimized | Efficient serialization |
+| Setup Time | Under 5 minutes | Drop-in integration |
 
-| **Metric** | **Improvement** | **Description** |
-|------------|----------------|-----------------|
-| **Database Load** | ↓ 60-90% | Automatic query caching |
-| **Response Time** | ↓ 200-500ms | Redis-fast cache hits |
-| **Memory Usage** | Optimized | Efficient serialization |
-| **Setup Time** | < 5 minutes | Drop-in integration |
-
-</div>
-
-## 🏗️ **Architecture**
+## Architecture
 
 ```mermaid
 graph TB
@@ -226,7 +222,7 @@ graph TB
     I --> J[Clear Related Cache]
 ```
 
-## 🧪 **Testing**
+## Testing
 
 ```bash
 # Install with dev dependencies
@@ -242,47 +238,39 @@ pytest --cov=yokedcache
 pytest tests/test_cache.py::TestAutoInvalidation
 ```
 
-## 🤝 **Contributing**
+## Contributing
 
 We welcome contributions! Here's how to get started:
 
-1. **Fork** the repository
-2. **Create** a feature branch: `git checkout -b feature/amazing-feature`
-3. **Make** your changes and add tests
-4. **Commit** your changes: `git commit -m "feat: add amazing feature"`
-5. **Push** to the branch: `git push origin feature/amazing-feature`
-6. **Open** a Pull Request
+1. Fork the repository
+2. Create a feature branch: `git checkout -b feature/amazing-feature`
+3. Make your changes and add tests
+4. Commit your changes: `git commit -m "feat: add amazing feature"`
+5. Push to the branch: `git push origin feature/amazing-feature`
+6. Open a Pull Request
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
 
-## 📊 **Project Status**
-
-<div align="center">
+## Project Status
 
 [![GitHub stars](https://img.shields.io/github/stars/sirstig/yokedcache?style=social)](https://github.com/sirstig/yokedcache/stargazers)
 [![GitHub forks](https://img.shields.io/github/forks/sirstig/yokedcache?style=social)](https://github.com/sirstig/yokedcache/network/members)
 [![GitHub issues](https://img.shields.io/github/issues/sirstig/yokedcache)](https://github.com/sirstig/yokedcache/issues)
 [![GitHub pull requests](https://img.shields.io/github/issues-pr/sirstig/yokedcache)](https://github.com/sirstig/yokedcache/pulls)
 
-</div>
+## License
 
-## 📄 **License**
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
-This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.
+## Acknowledgments
 
-## 🙏 **Acknowledgments**
-
-- **Redis** - For the excellent caching backend
-- **FastAPI** - For the amazing Python web framework
-- **SQLAlchemy** - For database ORM integration
-- **Python Community** - For continuous inspiration and feedback
+- [Redis](https://redis.io/) - For the excellent caching backend
+- [FastAPI](https://fastapi.tiangolo.com/) - For the amazing Python web framework  
+- [SQLAlchemy](https://www.sqlalchemy.org/) - For database ORM integration
+- Python Community - For continuous inspiration and feedback
 
 ---
 
-<div align="center">
-
-**Made with ❤️ by [Project Yoked LLC](https://github.com/sirstig)**
-
-*If YokedCache helps your project, please consider giving it a ⭐ on GitHub!*
+**Made with care by [Project Yoked LLC](https://github.com/sirstig)**
 
-</div>
+If YokedCache helps your project, please consider giving it a star on GitHub!