DotReadme

The Ultimate README Optimizer for VS Code

Write confident documentation. Simulate, Audit, and Fix your README
for GitHub, VS Code Marketplace, and Open VSX instantly.

🚀 Why DotReadme?

Creating a perfect README is hard. You write Markdown, push to GitHub, and realize the images are broken, the styling is off, or you missed important sections.

DotReadme fixes this workflow. It lives right inside VS Code and acts as your personal documentation assistant.

✨ Features

1. 🎭 Real-time Simulator

Preview your README exactly as it appears on popular platforms. No more "push and pray".

• VS Code Marketplace Mode: Perfect for extension developers.
• GitHub Mode: See how it looks on repositories.
• Open VSX Mode: For open-source registry compatibility.

2. 📊 Instant Quality Audit

Get a Live Health Score (A+ to F) for your documentation.

• Checks for missing sections (Installation, Usage, License).
• Verifies broken links and images.
• Suggests best practices to improve readability.

3. 🛠️ One-Click Path Fixer

Broken images on the Marketplace? Never again.

• Automatically detects your GitHub repository.
• Converts local paths (./images/logo.png) to absolute raw URLs.
• Ensures your images load everywhere.

4. 🛡️ Smart Badge Inserter

Add professional shields to your README in seconds.

• License, Version, Downloads, CI/CD Status.
• Auto-detects your repo info to generate the correct links.

📸 Screenshots

Quality Audit System	Marketplace Preview

GitHub Theme	Open VSX Theme

📦 Usage

Quick Actions (Sidebar)

Click the DotReadme icon in the Activity Bar to access quick commands:

• Open Simulator
• Fix Relative Paths
• Insert Badge

Command Palette

Press Ctrl+Shift+P (or Cmd+Shift+P on Mac) and type DotReadme:

1. Open Simulator: Launches the preview panel.
2. Quick Audit: Shows a notification with your current score.
3. Fix Relative Paths: Rewrites local links to GitHub raw URLs.
4. Insert Badge: Opens a picker to add status shields.

⚙️ Requirements

• VS Code ^1.90.0 or higher.
• An active Internet connection (for loading badges and simulator styles).

🤝 Contributing

Found a bug? Have a feature request? We love community feedback! Please open an issue on our GitHub Repository.

❤️ Support

DotReadme is an open-source project built with love. If this tool saved you time or improved your workflow, please consider supporting the development!

Your support helps keep the project alive, ad-free, and constantly evolving.

💖 GitHub Sponsors  |  ☕ Ko-fi  |  🅿️ PayPal

📄 License

This project is licensed under the MIT License.