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.

Written by Jean Galea
Last updated 9 years ago
WordPress

If you purchase through a link on our site, we may earn a commission.

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.

Written by Jean Galea

Jean Galea is an investor, entrepreneur, and writer. He is the founder of WP Mayor, and the plugins WP RSS Aggregator and Spotlight. He also runs AgentVania. Connect with him on X or LinkedIn, or visit jeangalea.com.

If you purchase through a link on our site, we may earn a commission.

2 Responses

David says:

December 20, 2013 at 11:54

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.