Skip to main content
Once you’ve created your README, Readme.so makes it easy to download the markdown file and use it in your project.

​
Downloading Your README

The download process is simple and works on both desktop and mobile devices.

​
How to Download

1

Complete Your README

Add and customize all the sections you need for your project
2

Click Download Button

Click the Download button in the top navigation bar
3

File Downloads Automatically

Your browser downloads a file named README.md containing all your content
4

See Success Message

A modal appears confirming your README was generated successfully
The download button is always visible in the navigation bar, even before you’ve added any content. You can download at any time.

​
Download Button Location

The download button appears in the top-right corner of the navigation bar with:
  • A download icon
  • The text “Download”
  • Emerald green background color
It’s positioned next to the dark mode toggle for easy access.

​
Download Process

Here’s what happens when you click the download button (from Nav.js:29-39): 
const downloadMarkdownFile = () => {
  const a = document.createElement('a')
  const blob = new Blob([markdown])
  a.href = URL.createObjectURL(blob)
  a.download = 'README.md'
  a.click()
  setShowModal(true)
}
1

Generate Markdown

All selected sections are combined in order into a single markdown string
2

Create Blob

The markdown text is converted to a Blob object
3

Trigger Download

A temporary download link is created and automatically clicked
4

Show Confirmation

The success modal appears with a celebration message

​
Downloaded File Format

The downloaded file has specific characteristics:

​
File Details

PropertyValue
FilenameREADME.md
FormatPlain text markdown
EncodingUTF-8
Line endingsSystem default
Extension.md

​
File Contents

The downloaded README contains:
  • All selected sections in their current order
  • All your custom edits and modifications
  • Raw markdown text (no HTML or metadata)
  • Proper markdown formatting with headers, code blocks, lists, etc.
# My Awesome Project

A brief description of what this project does and who it's for

## Features

- Light/dark mode toggle
- Live previews
- Fullscreen mode
- Cross platform

## Installation

Install my-project with npm

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

## License

[MIT](https://choosealicense.com/licenses/mit/)
The downloaded file includes only the sections you’ve added to your README. Sections from the library that you haven’t added are not included.

​
Success Modal

After downloading, a confirmation modal appears with helpful information. The success modal (implemented in DownloadModal.js) includes:

Celebration

A party emoji (🎉) celebrates your completion

Confirmation Message

“Your Readme has been generated”

Feedback Options

Links to support the creator via Twitter or Buy Me a Coffee
## Modal Message

Your Readme has been generated

Reach out to me on [Twitter](https://x.com/koushik_romel) if you have any feedback or suggestions!

If you found this useful, consider buying me a coffee!
The modal also includes:
  • A Buy Me a Coffee button linking to the creator’s page
  • A GitHub Sponsors button for ongoing support
  • Background overlay that closes the modal when clicked
The modal is dismissable - click anywhere outside the modal box or refresh the page to close it and continue editing.

​
Using Your Downloaded README

After downloading, you can use your README file in several ways:

​
Add to Your Git Repository

1

Locate Downloaded File

Find README.md in your Downloads folder
2

Move to Project Root

Copy or move the file to your project’s root directory
mv ~/Downloads/README.md /path/to/your/project/
3

Commit to Git

Add and commit the README to your repository
git add README.md
git commit -m "Add README documentation"
git push
4

View on GitHub

Your README automatically appears on your GitHub repository homepage

​
Use for GitHub Profile

For GitHub profile READMEs (using the github-profile sections):
1

Create Special Repository

Create a repository with the same name as your GitHub username
2

Add README

Place the downloaded README.md in the repository root
3

Commit and Push

Commit the file and push to GitHub
4

See Profile

Visit your GitHub profile to see your README displayed

​
Edit Externally

You can also edit the downloaded README in your preferred editor:

VS Code

Open with VS Code for syntax highlighting and markdown preview

Text Editor

Use any plain text editor (Notepad, TextEdit, vim, etc.)

IDE

Open in your IDE alongside your project code

Online Editors

Use GitHub’s web editor or other online markdown editors

​
Alternative Export Methods

While Readme.so focuses on downloading, you have other options for exporting your content:

​
Copy from Raw Preview

1

Switch to Raw Mode

Click the Raw tab in the Preview column
2

Select All Text

Use Ctrl+A (or Cmd+A on Mac) to select all markdown
3

Copy to Clipboard

Press Ctrl+C (or Cmd+C) to copy
4

Paste Anywhere

Paste into any editor or application
This is useful when you want to:
  • Paste directly into GitHub’s web editor
  • Add to a larger document
  • Share via email or chat
  • Import into another tool

​
Share with AI Tools

Readme.so includes a “Share to LLM” feature for AI-assisted editing:
The ShareToLLM component (from ShareToLLM.js) appears in the Preview column header and allows you to share your markdown with AI language models for suggestions and improvements.

​
Download Best Practices

​
Before Downloading

​
After Downloading

​
Re-downloading and Updates

You can download your README as many times as needed:
  1. Edit your content in Readme.so
  2. Click Download again to get the updated version
  3. Replace the old README.md file with the new one
  4. Commit the changes to Git
Each download creates a new file. Make sure to replace the old version in your project directory.

​
Browser Compatibility

The download feature works across all modern browsers:
BrowserSupportNotes
Chrome✅ Full supportDownloads to default location
Firefox✅ Full supportMay prompt for location
Safari✅ Full supportDownloads to default location
Edge✅ Full supportDownloads to default location
Mobile Safari✅ Full supportDownloads to Files app
Chrome Mobile✅ Full supportDownloads to Downloads folder
Some browsers may block automatic downloads if you have strict privacy settings enabled. Check your browser’s download settings if the file doesn’t download.

​
Troubleshooting Downloads

​
Download Doesn’t Start

If clicking the download button doesn’t work:
  1. Check browser permissions: Ensure automatic downloads are allowed
  2. Disable popup blockers: Some blockers interfere with downloads
  3. Try a different browser: Test if it’s browser-specific
  4. Check Downloads folder: The file may have downloaded without notification

​
File Has Wrong Extension

If your file downloads as .txt instead of .md:
  1. Rename the file manually to add .md extension
  2. Update your browser’s file type associations
  3. Use “Save As” and specify .md extension

​
Content Is Missing

If sections are missing from your downloaded file:
  1. Verify sections are in the “selected sections” list (not just available sections)
  2. Check that sections have content (not empty)
  3. Try downloading again
  4. Use the Raw preview to verify content before downloading

​
Continuous Workflow

Readme.so supports an iterative workflow:
1

Create Initial README

Add sections and create your first version
2

Download and Test

Download the file and test it in your repository
3

Make Improvements

Return to Readme.so to refine content (your work is saved in localStorage)
4

Re-download

Download the updated version and replace the old file
5

Repeat as Needed

Continue iterating until your README is perfect
Keep your Readme.so browser tab open while working on your project. You can easily switch back to make updates and re-download as your project evolves.

Build docs developers (and LLMs) love

Get started for freeTalk to us