DevinVinson / WordPress-Plugin-Boilerplate

[WordPress] A foundation for WordPress Plugin Development that aims to provide a clear and consistent guide for building your plugins.
http://wppb.io
7.66k stars 2.25k forks source link

Rename README.txt to README.md #557

Closed hackerrahul closed 3 years ago

AmmarRabie commented 3 years ago

Actually you shouldn't do that, as WordPress system requires you to name it README.txt. Also it make sense as the format of this file is not in .md format. some sections can accept it like description but the whole structure doesn't. If you are looking for readme for repo, you can find it in the repo root directory.


from WordPresss official docs

Each plugin should have a readme file named readme.txt that adheres to the WordPress plugin readme file standard.