Create Your Next Project's Readme With This Useful Tool

Developer Tools

April 30th, 2021

readme-dot-so-featured.png

Readme.so is the easiest way to create a readme markdown file for your next project, created by Katherine Peterson.

The readme.so editor gives you visual cues, starter section templates and includes many standard readme sections you're likely to use. It also has a nice preview to help guide you along the way.

Never forget a section for your readme again! Select sections to add to your readme, edit the contents, and drag to rearrange. See a live-updating rendered preview of your markdown, then download your README.md file!

Here's an example of starting an API section, which provides helpful formatting. You might need to specify API params:

The editor includes both light and dark editor support, and you can download or copy/paste the raw markdown of your readme into version control once you're done.

You can learn more about this project and start using it on readme.so. Also, be sure to check out readme.so on Product Hunt and upvote it if you find it useful!

Filed in:

Paul Redmond

Full stack web developer. Author of Lumen Programming Guide and Docker for PHP Developers.