How to Preview Your Plugin’s Readme.txt File

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.
Table of Contents

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.

Jean Galea
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.

Consider sharing this post so others can find it:

Stay in the know on the latest and greatest products and services in WordPress. We'll send you one email every week with new and trending tutorials and reviews.

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.

Leave a Reply

Your email address will not be published.

Haven't found an answer to your question? Ask us about it.
Although we publish new posts every week, we might not be answering your questions. Recommend a topic and we'll do our best to cover it in one of our next posts.
From hosting to plugins and backup services, the Mayor's office has put together a collection of amazing WordPress deals!
WP Mayor_Icon_white

Join the mayor’s club

Stay in the know on the latest and greatest products and services in WordPress