VS Code Readme Editor 📝

A VS Code extension to create, customize and save your Readme without having to leave your project workspace.

Built with TypeScript & React using the VS Code Webview API

Over 10k Downloads! (May 2023)

VS Code Extension Marketplace

https://marketplace.visualstudio.com/items?itemName=SumitNalavade.vscode-readme-editor

Installation

In the VS Code extension marketplace look up:

  SumitNalavade.vscode-readme-editor

Features ✨

• Accessibility in VS Code
• Choose from components to speed up your workflow.
• Download directly to project root
• Import existing Readme and customize
• Live Previews
• Dark/Light Mode based on VS Code theme

Demo 🚀

Contributing 🧑‍💻

Contributions are always welcome!

• Open an issue
• I'll review the issue and assign you
• Open a pull request!

Run Locally 🏠

Clone the project

  git clone https://github.com/SumitNalavade/VS-Code-ReadMe-Editor

Go to the project directory

  cd vscode-readme-editor

Install dependencies

npm install

Start the extension

• Press 'F5' on your machine to open the VS Code extension development preview.

License 💼

MIT

Acknowledgements ❤️

• Readme.so
• Awesome README
• How to write a Good readme

Contributors 💙

• Sumit Nalavade
• Unjin Jang
• hacker0limbo

Feedback 📣

If you have any feedback, please reach to me at [email protected].