Top Highlights

• Understanding Readme.txt At it’s heart, the Readme.txt file is pretty basic. You put in the information, it generates a WordPress page. Of course, it’s not all simple magic, and there are some weird things to be aware of. To help people better understand how it works, the Plugin Directory documentation has been updated, but here’s a quick primer:
• If you use Tags, so will the directory If you put the stable version of 1.2.3 in your readme, the rest of the content will be pulled from /tags/1.2.3 and not the trunk folder. Readmes use Markdown (mostly) Most Markdown calls work as expected. Tables do not. But this means don’t put JS or CSS in your readme. It will break things. Videos A YouTube...
• (File) Size Matters If your Readme is over 10k, weird parsing things happen. Some tips to keep it small: Move your previous versions’ changelogs to their own file – changelog.txt Self-host seriously intensive documentation Make your readme a ‘how to’ and ‘why this is awesome’ but not a sales pitch for your pro version Don’t keyword stuff (someone ...
• Well written readmes get more users Want to rank higher? Write a good readme. It’s actually much less about keyword stuffing than it is keeping users. After all, we’ve all seen a plugin with 20k downloads but only 10+ active users. That means you’re getting people’s attention and not delivering. So write a good readme that sells what you do, and se...

Domain