# WPreadme.com

> WPreadme.com previews and validates WordPress plugin readme.txt files in the browser. It runs the WordPress.org plugin directory's own readme parser and validator, in PHP compiled to WebAssembly, so a readme renders and validates as it would on WordPress.org.

Paste a readme.txt into the page and, as you type, it shows the plugin page as WordPress.org would (description, FAQ, installation, changelog, contributors and plugin details) and an Issues tab with the validator's errors, warnings and notes. The readme is parsed on your own device; only the contributor names leave it, for the profile lookup below. "Preview a Sample" loads the readme of a popular plugin.

There is no API or command-line version; the page needs a browser with JavaScript and WebAssembly.

## Where it differs from WordPress.org

- Contributors: each name is looked up on profiles.wordpress.org, and names without a profile are marked. The lookup only knows profile names, so a username that differs from its profile name is marked too, while WordPress.org accepts it.
- Tags: whether a tag is widely used needs the plugin database, so it is not checked.
- Tested up to: compared with the latest WordPress release from api.wordpress.org, as WordPress.org does.
- Videos: YouTube, Vimeo and VideoPress URLs alone on a line are embedded, as WordPress.org does.

## Pages

- [WPreadme.com](https://wpreadme.com/): the previewer and validator.
- [The WordPress plugin readme.txt](https://wpreadme.com/readme-txt): the format field by field, a template that passes the validator, and a fix for each validator message.

## WordPress.org references

- [Readme file standard](https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/): the readme.txt format and its headers.
- [WordPress.org readme validator](https://wordpress.org/plugins/developers/readme-validator/): the official validator.
- [Plugin Developer FAQ](https://developer.wordpress.org/plugins/wordpress-org/plugin-developer-faq/)
- [Submit a plugin](https://wordpress.org/plugins/developers/add/)