A simple Visual Studio Code extension that adds a dedicated README button to the Activity Bar.
📖 When clicked, it automatically opens the first matching README file (README.md, readme, README, etc.) in preview mode.
✨ Features
- 🗂 Scans the root of your workspace for any of the following:
README.mdREADMEreadme.mdreadme
- 📌 Adds a "README" icon to the Activity Bar
- 📄 Clicking it opens the README in Markdown preview mode
- 💡 Supports both
.md and extension-less README files
📷 Screenshot
🚀 Usage
- Open a project folder in VS Code that contains a
README.md (or similar).
- Look for the README icon in the left Activity Bar.
- Click it — your README will open instantly in preview mode.
🔧 Requirements
No dependencies required. Just install and go.
🛠 Extension Settings
This extension has no configuration options (yet). It just works.
🧪 Known Limitations
- Only scans the root workspace folder
- Only handles the first matching file
- Doesn’t currently scan subfolders (e.g.,
docs/README.md)
📦 Installation
Install from the Visual Studio Marketplace
Or install manually:
code --install-extension readme-button.vsix
| |
