octokatherine/readme.so

★ 4,633JavaScriptAudience · developerComplexity · 1/5LicenseSetup · easy

Mindmap

mindmap
  root((readme.so))
    Editor
      Live preview
      Drag and drop
      No signup needed
    Sections
      Installation steps
      Features list
      Usage examples
      License info
    Tech
      Next.js
      TailwindCSS
      dnd kit
      react-markdown
    Output
      Download README
      Markdown format
    Community
      Open source
      Contributions welcome

mindmap root((readme.so)) Editor Live preview Drag and drop No signup needed Sections Installation steps Features list Usage examples License info Tech Next.js TailwindCSS dnd kit react-markdown Output Download README Markdown format Community Open source Contributions welcome

Click or tap to explore — scroll the page freely

Things people build with this

USE CASE 1

Quickly create a professional README for a new project without writing from scratch

USE CASE 2

Pick and arrange common documentation sections like installation, features, and usage

USE CASE 3

Preview how your README will look formatted before downloading it

USE CASE 4

Get a solid documentation starting point for open-source or portfolio projects

Tech stack

JavaScriptNext.jsTailwindCSSdnd kitreact-markdown

Getting it running

Difficulty · easy Time to first run · 5min

No account or installation required. Open the site in a browser, pick sections, edit, and download your README file immediately.

MIT license, free to use, modify, and share for any purpose, including commercial projects.

In plain English

readme.so is a web-based editor that helps developers write the README files that accompany their software projects. A README is the first document visitors see when they find a project on a code-sharing platform like GitHub, and writing a good one from scratch can be time-consuming. This tool makes that process faster by providing a ready-made set of common sections you can pick, fill in, and rearrange. The workflow is straightforward: you choose from a list of pre-built sections such as installation instructions, features, usage examples, license information, and so on. You can then edit the text inside each section, drag them into whatever order makes sense for your project, and download the finished README file. The editing happens live in the browser with no account or setup required. Under the hood the site is built with Next.js for page rendering, TailwindCSS for styling, dnd kit for the drag-and-drop behavior, and react-markdown to show a preview of how the formatted text will look. The project is open source under the MIT license, meaning anyone can use, modify, and redistribute it freely. The README for this project is short and does not describe advanced options or configuration. The tool is aimed at developers who want a quick starting point for their project documentation rather than a full writing environment. Contributions and feedback from the community are welcomed, with guidelines available in the project's contributing file.

Copy-paste prompts

Prompt 1

I am using readme.so to build a README for my project. Suggest the best sections to include for a web app that users sign up for and pay monthly.

Prompt 2

Here is my README draft made with readme.so: [paste text]. Rewrite it in plain English so non-technical investors can understand what the project does.

Prompt 3

I downloaded a README from readme.so. Help me fill in the Installation section for a Node.js project that uses npm.

Prompt 4

Using the sections available in readme.so (Features, Usage, Installation, License, Contributing), write a complete README for a browser extension that blocks distracting websites.

Prompt 5

I want to contribute a new section template to readme.so. Suggest 3 section ideas that most developers would find useful and explain what each should contain.

Open on GitHub → Explain another repo

← octokatherine on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.