How To Make Wordpress Plugin Readme.txt File

How important is Read.txt file for a new plugin that has been developed by you from your point of view, do you view it as just an accessory to your plugin installation but it is not just like that it defiantly is a very useful part of the installation on which you also need to focus upon.

Some code writers though capable of developing great plugin hardly give any importance to the Read.txt file, they see it as wastage of time and this can lead to a lot of negative aspects which can hamper the reputation of the plugin developed though it might be really too impressive to use let us analyze why?.

• A Read.txt file without details will show that you don’t bother about your users.


• By a Readme file you can explain your users why and for what reasons is your plugin so significant.


• In the Readme file highlight the Installation process and the important Features of your developed code.


• Don’t forget to include the FAQ.


• Provide relevant help links in the file for further support or clarification.

There are certain tools that can help you to make a Read.txt file:

• Templates for Read.txt


• Generator for Read.txt


• Validate the Read.txt

How to write the Readme file

• You can use tools such as Markdown that can convert simple text into HTML but still it will look good and be readable to you in the ‘WordPress Edit plugin’


• Take a nice look at Syntax that is required to write a Readme file with its significance for the write-up.

How to write the Plugin Header

The plugin header must contain some basic information about the plugin:

• Name of the plugin and its version that should be in numerical format.


• Author or the developer of the plugin


• If you want you can put a donate link for earning some cash.


• Add Tags to the header so that it could be easily searched out by relevant users for that plugin.


• Include the wordpress version requirement for your plugin; that is in which version the plugin works the best.


• Include your home page as Author URL and the plugin URL to the plugin header.

How to write the Plugin Description

• Try to make the description in the wordpress.org page short and simple to the point.


• If possible you can embed a video about your plugin.


• Make the key features available to the downloader’s to make your plugin catchier.


• Make a profile link of the plugin to some of the important social networking site.


• Include any specific requirements for the plugin.

How to write about the Plugin Installation Procedure

• The installation instructions must go step by step


• Include the requirements of installation


• State if any specific measures are to be taken for installation.


• Make a list of the things (if any) that are needed for installation.

Frequently Asked Questions

• FAQ is the section where the plugin code developer must in advance anticipate the questions with there answers while making an analysis of what kind of problems a wordpress developer can face while using or installing the plugin, so it will act as a support and problem trouble shooter to the plugin.


• Add more questions to the FAQ section through the reference of your plugin support forum.

Is Screenshot Really Required

The plugin developer might not feel the importance of screenshots but from the user’s point of view an Users Interface (UI) screenshots have a big significance. It helps the user to understand is it really what they were looking for? The screenshots should not be too small.

You Can add Other Notes

You can add another section ‘Other Note’s to include information regarding License, Filters, Availability in local language, Copyright Credits.

What Does Changelog Do

Changelog section states the history of the plugin starting from the bottom the older versions to the newer version towards the top.Changelog tells the users the development statistic of the plugin over the time.