Целью данной статьи является описание для разработиков принятых стандартов в readme-файлах плагинов. Если Вы не пишете плагины для WordPress, то можете смело закрывать страницу.

Ниже приведен пример readme-файла с расшифровкой каждой секции.

=== Имя плагина ===
Contributors: lxx
Donate link: http://example.com/
Tags: comments, spam
Requires at least: 2.0.2
Tested up to: 2.1
Stable tag: 4.3

Здесь следует привести краткое описание Вашего плагина. До 150 символов.

== Description ==

В этой секции следует дать подробное описание Вашего плагина. Ограничений на длину текста нет.

Описание полей в верхней секции:
* «Contributors» — список пользователей-разрабтчиков плагина. Перечисляются через запятую.
* «Tags» — список тегов, под которые подходит Ваш плагин.
* «Requires at least» Минимально необходимая для работы плагина версия WordPress.
* «Tested up to» — максимальная версия WordPress, на которой плагин прошел удачное тестирование.
* «Stable tag» — стабильная версия Вашего плагина.

== Installation ==

В этой секции описывается процедура установки плагина.

1. Загрузите `plugin-name.php` в папку `/wp-content/plugins/`
2. Активируйте плагин в центре управления плагинами
1. Вставьте код `` в свою тему

== Frequently Asked Questions ==

= Вопрос №1 =

Ответ на вопрос №1

= Вопрос №2 =

Ответ на вопрос №2

== Screenshots ==

1. Это опиание скриншота screenshot-1.(png|jpg|jpeg|gif). Файлы скриншотов должны лежать рядом с файлом readme.txt
2. Описание второго скриншота

== Changelog ==

= 0.1 =
* Изменения в версии
* Еще изменения

= 0.2=
* Снова изменения