Skip to main content

Build Professional READMEs in Minutes

An intuitive drag-and-drop editor that helps developers create beautiful, comprehensive README files for their GitHub projects without starting from scratch.

Get StartedExplore Features
README editor interface preview

Quick start

Get up and running with Readme.so in just a few steps

1

Visit the Editor

Navigate to readme-so-community.vercel.app to access the online editor. No sign-up required — start building immediately.
2

Select Sections

Browse the sections library on the left sidebar and click any section to add it to your README. Choose from templates like Installation, Features, API Reference, Contributing, and more.
Sections are automatically saved to your browser’s local storage, so your work is preserved between sessions.
3

Customize Content

Click on any added section in the middle column to edit its content. Use the Monaco editor with markdown syntax highlighting to write and format your documentation.
4

Export Your README

Preview your README in real-time on the right side. When you’re satisfied, click the download button in the navigation bar to save your README.md file.
# Your downloaded file is ready to use
mv ~/Downloads/README.md /path/to/your/project/
git add README.md
git commit -m "Add comprehensive README"

Key features

Everything you need to create professional documentation

Drag-and-Drop Interface

Reorder sections effortlessly with intuitive drag-and-drop functionality powered by dnd-kit.

30+ Section Templates

Pre-built templates for common README sections including badges, installation, usage, API reference, and more.

Live Preview

See your README rendered in real-time with full markdown support and syntax highlighting.

Multi-Language Support

Interface available in English, Chinese, Portuguese, and Turkish with i18n support.

Dark Mode

Toggle between light and dark themes for comfortable editing at any time of day.

Auto-Save

Your work is automatically saved to browser storage — never lose progress.

Explore by topic

Dive deeper into specific areas

Section templates preview

Section Templates

Explore all available README sections and learn when to use each one

View templates
Architecture diagram

Architecture Overview

Understand how the editor works under the hood and how to contribute

Learn more

Resources

Everything you need to get help and stay up to date

FAQ

Find answers to common questions about using the editor

Contributing

Learn how to contribute to the open-source project

Changelog

See what’s new in recent releases

Ready to create your README?

Join thousands of developers using Readme.so to build professional documentation

Launch EditorView on GitHub