WordPress Black Friday & Cyber Monday Deals 2021
Days
Hours
Minutes
Seconds

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.

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:

Share on facebook
Share on twitter
Share on linkedin
Share on reddit
Share on telegram
Share on whatsapp
Share on pocket
Share on email

Join thousands of people receiving real-world, genuine evaluations of WordPress products and services just like this one every week.

Our Sponsors
Solid Affiliate
Contents

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. Required fields are marked *

The Beginner’s Handbook
From an introduction on how WordPress works to our recommendations on products and services.
👋 Hey there! We're Gaby and Mark
Every week we share tutorials and genuine reviews of WordPress products and services in our newsletter.
Thousands of people read it!
We’d love for you to join.
We’d love for you to join. Here’s what you’ll be getting:

A single weekly email directly to your inbox.