Skip to main content

​
What is Readme.so?

Readme.so is a free, open-source web application that helps developers create comprehensive README files for their projects. Instead of starting from scratch or copying templates, you can build a professional README in minutes using an intuitive drag-and-drop interface with pre-built sections.
Readme.so is completely free and requires no sign-up. Your work is automatically saved to your browser’s local storage.

​
Who is it for?

Readme.so is perfect for:

Open Source Maintainers

Create comprehensive documentation that helps contributors understand and contribute to your project

Individual Developers

Build professional READMEs for personal projects and portfolios

Teams

Standardize documentation across multiple repositories

Students

Document school projects and coding assignments professionally

​
Key Benefits

​
Save Time

No need to remember markdown syntax or search for README templates. Readme.so provides 30+ pre-built sections including:
  • Title and Description - Project overview
  • Installation - Setup instructions
  • Usage/Examples - Code samples
  • API Reference - Endpoint documentation
  • Contributing - Contribution guidelines
  • License - License information
  • And many more…

​
Professional Results

Every section comes with a well-structured template following best practices for technical documentation. Simply customize the content to match your project. 
## Installation

Install my-project with npm

\`\`\`bash
  npm install my-project
  cd my-project
\`\`\`

​
Intuitive Interface

Built with modern web technologies for a seamless editing experience:
1

Browse Sections

View all available sections in the left sidebar
2

Add & Arrange

Click to add sections, then drag and drop to reorder them
3

Edit Content

Click any section to edit with Monaco Editor (the same editor used in VS Code)
4

Preview in Real-Time

See your README rendered with full markdown support

​
Multi-Language Support

The interface is available in multiple languages:
  • English
  • 中文 (Chinese)
  • Português (Portuguese)
  • Türkçe (Turkish)
  • Español (Spanish)
  • Français (French)
  • Deutsch (German)
  • And 10+ more languages

​
Core Features

Drag-and-Drop Sections

Reorder sections effortlessly using dnd-kit’s smooth drag-and-drop functionality

Live Markdown Preview

See your README rendered in real-time with syntax highlighting powered by react-markdown

Monaco Code Editor

Edit content with the same powerful editor used in Visual Studio Code

Auto-Save

Your work is automatically saved to browser local storage - never lose progress

Dark Mode

Toggle between light and dark themes for comfortable editing

Custom Sections

Create your own custom sections beyond the built-in templates

Search & Filter

Quickly find the sections you need with built-in search

Export to Markdown

Download your completed README as a .md file ready for your repository

​
Tech Stack

Readme.so is built with modern web technologies:
  • Next.js 16 - React framework for production
  • React 19 - UI component library
  • Tailwind CSS 3 - Utility-first CSS framework
  • dnd-kit - Modern drag-and-drop library
  • Monaco Editor - Code editor from VS Code
  • react-markdown - Markdown rendering
  • next-i18next - Internationalization
Readme.so is open source and community-maintained. Contributions are welcome!

​
Getting Started

Ready to create your first README? Check out the Quickstart Guide to begin.

Quickstart

Learn how to create your first README in just a few minutes

​
Community & Support

GitHub Repository

Star the repo, report issues, or contribute code

Live Application

Start using Readme.so right now - no installation required
Your README content is stored in your browser’s local storage. For long-term backup, regularly download your README files or copy the content.

Build docs developers (and LLMs) love

Get started for freeTalk to us