How to Preview Your Plugin’s Readme.txt File

Written by Jean Galea
Written by Jean Galea
The readme.txt file is an essential file when submitting plugins to the WordPress.org repository. There is an excellent article on Smashing Magazine which highlights all the important things you need to know when creating a readme.txt file. When you're ready and want to preview how the file will look into the repository, you can use this tool.

Partner Sponsors

BionicWP

Full disclosure: If you purchase through a link on our site, we may earn a commission. Learn more.

The readme.txt file is an essential file when submitting plugins to the WordPress.org repository.

There is an excellent article on Smashing Magazine which highlights all the important things you need to know when creating a readme.txt file.

When you’re ready and want to preview how the file will look into the repository, you can use this tool.

This article was filed in our archives.
Written by Jean Galea
Jean Galea is an investor, entrepreneur, and blogger. He is the founder of WP Mayor, the plugins WP RSS Aggregator and Spotlight, as well as the Mastermind.fm podcast. His personal blog can be found at jeangalea.com.

In this article

Discover More

2 Responses

  1. Took me a long time to find the README file. But, for those pondering writing them may I suggest that you focus on how to use the plugin in plain, non-coder, language. Those readme files are often obtuse and unhelpful. What is second nature to you is not the new user. Then, tell why the plugin is different from some other approaches so that one can easily understand why/why-not to use it.

Share Your Thoughts

Your email address will not be published. Required fields are marked *

New discoveries, every week.
Join thousands of designers, developers, and builders that come to WP Mayor to find the best guides, tools, and services for their next website. One email, once a week.
WP Mayor Newsletter

Claim Your Free Website Tip 👇

Leave your name, email and website URL below to receive one actionable improvement tip tailored for your website within the next 24 hours.

"They identified areas for improvement that we had not previously considered." - Elliot

By providing your information, you'll also be subscribing to our weekly newsletter packed with exclusive content and insights. You can unsubscribe at any time with just one click.

What's missing?