POEditor MCP Server

# 🏷️ Badges Reference Guide This file explains all the badges used in the README.md and how to maintain them. ## 📋 Badge Categories ### **Release & Version Badges** ```markdown [](https://github.com/r-pedraza/poeditor-mcp/releases) ``` - **Updates automatically** when you create new releases - **Action needed**: Create releases with proper tags (`git tag v1.0.1`) ### **Technology Stack Badges** ```markdown [](https://www.python.org/) [](https://opensource.org/licenses/MIT) ``` - **Static badges** - Update manually when requirements change - **Python version**: Update when minimum Python version changes ### **Project Integration Badges** ```markdown [](https://github.com/modelcontextprotocol) [](https://poeditor.com/) [](https://claude.ai/) [](https://code.visualstudio.com/) ``` - **Static badges** showing compatibility - **Update when**: Adding/removing client support ### **Repository Statistics Badges** ```markdown [](https://github.com/r-pedraza/poeditor-mcp/stargazers) [](https://github.com/r-pedraza/poeditor-mcp/issues) [](https://github.com/r-pedraza/poeditor-mcp/pulls) [](https://github.com/r-pedraza/poeditor-mcp/commits/main) [](https://github.com/r-pedraza/poeditor-mcp) ``` - **Updates automatically** from GitHub data - **No action needed** - they refresh automatically ### **Project Status Badges** ```markdown [](https://github.com/r-pedraza/poeditor-mcp) [](https://github.com/r-pedraza/poeditor-mcp/commits/main) [](https://poeditor.com/docs/api) [](https://github.com/r-pedraza/poeditor-mcp#documentation) ``` - **Manual badges** that you update as the project evolves - **Update when**: Project status changes ## 🎨 Badge Customization ### Colors - `brightgreen` - Success/Complete features - `green` - Good status - `yellow` - Warning/In progress - `orange` - Attention needed - `red` - Issues/Broken - `blue` - Information - `lightgrey` - Neutral ### Adding New Badges 1. **Choose a service**: [Shields.io](https://shields.io/) for most badges 2. **Format**: `[](link)` 3. **Test the badge** before committing 4. **Add to this file** for future reference ### Useful Badge Generators - **[Shields.io](https://shields.io/)** - Main badge service - **[GitHub Badges](https://github.com/badges/shields)** - GitHub-specific badges - **[Custom Badges](https://shields.io/category/other)** - Create custom badges ## 📝 Maintenance Schedule ### **Weekly** (Automated) - Repository statistics badges update automatically ### **Monthly** (Manual Check) - Verify project status badges are accurate - Update development status if needed - Check if technology badges need updates ### **Per Release** (Manual) - Ensure version badges are correct - Update feature completion status - Add new integration badges if applicable ## 🚀 Future Badge Ideas When the project grows, consider adding: ```markdown [](https://github.com/r-pedraza/poeditor-mcp/actions) [](https://codecov.io/gh/r-pedraza/poeditor-mcp) [](https://pypi.org/project/poeditor-mcp/) [](https://github.com/r-pedraza/poeditor-mcp/releases) [](https://github.com/r-pedraza/poeditor-mcp/graphs/contributors) ``` ## 📖 Badge Best Practices 1. **Don't overdo it** - Too many badges can be overwhelming 2. **Keep them relevant** - Only show badges that provide value 3. **Group logically** - Related badges should be grouped together 4. **Update regularly** - Outdated badges hurt credibility 5. **Test links** - Ensure all badges link to relevant pages