Wp Readme Optimizer logo

Wp Readme Optimizer

Community
jdevalk
wp-readme-optimizer

Reviews and rewrites WordPress.org plugin readme.txt files for maximum quality. Use this skill whenever a user pastes, uploads, or references a WordPress plugin readme.txt, or asks to improve, audit, review, score, or optimize a plugin's WordPress.org listing page. Also trigger when the user says things like "make my plugin page better", "optimize my readme", "help me rank higher on WordPress.org", or "review my plugin listing". Always run the full audit + rewrite workflow unless the user explicitly asks for only one part.

Overview

Publisherjdevalk
Repositoryskills
Skill namewp-readme-optimizer
Stars
109
Forks
10
Bundled files
2
LicenseMIT
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • 2 bundled files

    Scripts, templates, and references the model can read while it works. Files are read-only and never executed.

  • Open source

    Published by jdevalk on GitHub. Read the source before you install it.

Installation

Install the Wp Readme Optimizer AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/jdevalk/skills/tree/main/wp-readme-optimizer
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/jdevalk/skills.git /tmp/skills
mkdir -p .claude/skills
cp -r /tmp/skills/wp-readme-optimizer .claude/skills/wp-readme-optimizer
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Wp Readme Optimizer in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Wp Readme Optimizer on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Wp Readme Optimizer is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

WordPress Plugin readme.txt Optimizer

This skill reviews a WordPress.org plugin readme.txt file with a structured audit, scores each section, and then produces a fully rewritten version. The goal is higher visibility in the WordPress.org plugin directory, better conversion of visitors to installs, and a more trustworthy plugin page.

Rewrite recipes live in AGENTS.md — read it when producing the rewritten readme.

Workflow

  1. Read the readme.txt — If a file is attached, read it. If the user pasted content, use that. If neither, ask the user to provide the readme.txt content.
  2. Infer the target keyword — Before scoring, identify what keyword(s) this plugin should rank for. This anchors the entire audit.
  3. Run the audit — Score each section and write specific, actionable findings.
  4. Produce the rewrite — Deliver a drop-in replacement readme.txt, incorporating all audit findings. Follow the recipes in AGENTS.md.

Phase 0: Keyword Inference

Before scoring, output: Primary keyword (the 2-3 word phrase most likely to drive installs), Secondary keywords (3-4 supporting terms), Inferred from (plugin name / tags / description), Confidence (high / medium / low).

Infer by asking: "If a WordPress site owner needed this plugin, what would they type into the search bar?" Look at the plugin name, tags, and the first paragraph. If confidence is low, add <!-- Couldn't confidently infer primary keyword --> and proceed with your best guess.

All scoring in Phase 1 is evaluated against this inferred keyword.


Phase 1: Audit

Scoring

Score each of the 8 sections below out of 10 (total /80). Show a summary table at the top of the audit. Score ranges: 65-80 strong (polish only), 45-64 solid with gaps, 25-44 significant problems, 0-24 bare minimum.

For each section, write 2-5 specific findings. A finding should name the problem, explain why it matters, and suggest a fix. Never be generic -- always refer to the actual content.

What to evaluate per section

Plugin Name & Tags
  • Is the name descriptive of what the plugin does, not just a brand name?
  • Does it include the primary keyword users would search for?
  • Are up to 5 tags used? Are they the right ones -- high-volume, specific to the plugin's function?
  • Would a stranger immediately understand what the plugin does from the name alone?
Short Description (<=150 chars)
  • Does it lead with the user's problem or benefit, not the plugin's name?
  • Is it under 150 characters (hard limit -- truncation kills CTR)?
  • Does it contain the primary keyword naturally?
  • Is it specific (avoid vague claims like "powerful", "easy", "best")?
  • Does it end before 150 chars -- not mid-sentence?
Long Description
  • Does the first paragraph act as a strong hook -- benefit-led, not feature-led?
  • Is the primary keyword used in the first 150 words?
  • Are there H2/H3 headings to break up the text (using == Heading == syntax)?
  • Are features presented as user benefits, not just a bullet dump?
  • Is there social proof -- active installs, ratings, notable users?
  • Is there a clear call to action (e.g. link to Pro, docs, or demo)?
  • Does it include FAQ-style content or video embeds for richness?
  • Are secondary/long-tail keywords naturally woven in?
Installation
  • Are the steps numbered and complete?
  • Does it cover both manual (FTP) and automatic (dashboard) methods?
  • Are there any post-activation steps mentioned?
FAQ
  • Are the questions things real users actually ask (check support forum topics if possible)?
  • Do the answers contain keywords naturally?
  • Is there at least one question that surfaces a common objection or concern?
  • Are questions phrased the way a user would type them, not how a developer would write them?
Screenshots
  • Is there a == Screenshots == section?
  • Does each screenshot have a caption (captions are indexed by the search engine)?
  • Do captions describe what the user sees AND include relevant keywords?
  • Are there enough screenshots to cover the key UI flows?
Changelog
  • Is the changelog up to date?
  • Does it follow the format = X.X.X = with bullet points underneath?
  • Does the most recent entry communicate user-facing value, not just "bug fixes"?
  • Is there a reasonable update cadence visible (signals active maintenance)?
Stable Tag & Plugin Headers
  • Does Stable tag: match the latest tag in the /tags/ SVN directory?
  • Is Requires at least: conservative enough to not exclude users?
  • Is Tested up to: current (within 1-2 major WP releases)?
  • Is Requires PHP: declared?
  • Is License: declared (GPL-2.0-or-later)?

Phase 2: Rewrite

After the audit, produce the complete rewritten readme.txt. Read AGENTS.md for the full rewrite rules, section-by-section writing guidance, and the format reference.

AGENTS.md sections: Rewrite rules, Plugin Name & Tags, Short Description, Long Description, Installation, FAQ, Screenshots, Changelog, Stable Tag & Headers, Format Reference.


Phase 2.5: Metadata and readability pass

After producing the rewritten readme.txt, run two passes before presenting it:

  1. Metadata pass -- metadata-check skill. Run on the plugin name, short description, and each FAQ answer. Checks front-loading, concreteness, filler, truncation fit, one-idea-per-field.
  2. Prose pass -- readability-check skill. Run on the long description only. Skip headers block, changelog, and installation steps.

The WordPress.org audience is global -- many users read English as a second language. Apply fixes directly. Prioritize: (1) the short description, (2) the first paragraph of the long description, (3) FAQ answers.


Output format

## Audit with score table and per-section findings, then ---, then ## Rewritten readme.txt with the complete file inside a code block.


Key principles

  • Elastic Search powers the directory. Keywords in title, tags, short description, headings, and FAQ questions carry weight -- natural language wins over stuffing.
  • Short description is highest-leverage. It's the search-result snippet. Weak copy kills CTR before anyone reads the description.
  • Update recency is a trust signal. A stale "last updated" date loses installs.
  • Support rating is a ranking factor. Flag if the description could invite unnecessary negative reviews.
  • Screenshot captions are indexed. They're SEO content, not just UX.
  • Write for intent, not features. Lead with outcomes -- what the user achieves, not what the plugin is.

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Wp Readme Optimizer AI skill do?

Reviews and rewrites WordPress.org plugin readme.txt files for maximum quality. Use this skill whenever a user pastes, uploads, or references a WordPress plugin readme.txt, or asks to improve, audit, review, score, or optimize a plugin's WordPress.org listing page. Also trigger when the user says things like "make my plugin page better", "optimize my readme", "help me rank higher on WordPress.org", or "review my plugin listing". Always run the full audit + rewrite workflow unless the user explicitly asks for only one part.

Why use Wp Readme Optimizer on TypingMind?

Because you install it once and use it with any model. Wp Readme Optimizer is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Wp Readme Optimizer in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/jdevalk/skills/tree/main/wp-readme-optimizer. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Wp Readme Optimizer?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Wp Readme Optimizer?

As many as you like. As long as a model supports skills, you can use Wp Readme Optimizer with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Wp Readme Optimizer AI skill free?

Yes. It is published on GitHub by jdevalk under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇