diff --git a/README.md b/README.md index 6f98513..961f30f 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,103 @@ + # Advanced SEO Meta + AI FAQ Schema -Advanced SEO Meta + AI FAQ Schema is a WordPress plugin that helps you control how your content appears in search results and AI-powered search experiences. +Advanced SEO Meta + AI FAQ Schema is a lightweight WordPress plugin that adds fine-grained control over page titles, meta descriptions, Open Graph tags, and automatic JSON-LD FAQ output to improve visibility in classic search and AI-powered search experiences. + +![Version](https://img.shields.io/badge/version-1.0.0-blue.svg) ![WordPress](https://img.shields.io/badge/wordpress-5.8%2B-brightgreen.svg) ![PHP](https://img.shields.io/badge/php-7.4%2B-8892BF.svg) + +## Summary + +- One-line: Add custom SEO title, meta description, Open Graph and FAQ JSON-LD for posts and pages. + +## Requirements + +- WordPress 5.8 or later +- PHP 7.4 or later ## Features - Custom SEO title field for posts and pages -- Custom meta description field for better search snippet control -- FAQ builder that lets you add multiple questions and answers -- Automatic JSON-LD FAQPage schema output for AI search engines such as Google SGE and Bing Chat -- Open Graph tags for Facebook and LinkedIn sharing -- Clean meta box in the WordPress editor for easy content optimization +- Custom meta description field for improved search snippets +- FAQ builder to add multiple questions and answers per post/page +- Automatic JSON-LD `FAQPage` schema output for AI search engines (Google SGE, Bing Chat, etc.) +- Open Graph meta tags for Facebook, LinkedIn, and other social previews +- Clean meta box in the WordPress editor for quick optimization ## What the plugin adds -When editing a post or page, you can fill in: +When editing a post or page you can enter: - SEO Title - Meta Description - FAQ questions and answers -The plugin then outputs: +On the front end the plugin outputs: -- A custom page title override +- A page title override when provided - A meta description tag - Open Graph meta tags - Structured FAQ schema in JSON-LD format ## Installation -1. Upload the plugin folder to your WordPress installation's plugins directory. -2. Activate the plugin from the WordPress admin panel. -3. Edit any post or page and look for the "Advanced SEO & AI FAQ Schema" meta box. +1. Upload the plugin folder to your WordPress installation's `wp-content/plugins/` directory and activate it under `Plugins` → `Installed Plugins`. +2. Or install from ZIP: `Plugins` → `Add New` → `Upload Plugin` → choose the ZIP and click `Install Now`. +3. After activation, edit any post or page and look for the "Advanced SEO & AI FAQ Schema" meta box in the editor. ## Usage 1. Open a post or page in the editor. -2. Enter a custom SEO title and meta description. -3. Add one or more FAQ entries using the built-in builder. -4. Publish or update the post to make the SEO and schema output available on the front end. +2. Fill in the custom SEO Title and Meta Description as needed. +3. Use the FAQ builder to add one or more question/answer pairs. +4. Publish or update the post — the JSON-LD will be added to the page head automatically. + +### Example JSON-LD output + +```json +{ + "@context": "https://schema.org", + "@type": "FAQPage", + "mainEntity": [ + { + "@type": "Question", + "name": "What does this plugin do?", + "acceptedAnswer": { + "@type": "Answer", + "text": "It adds custom SEO title, meta description, Open Graph tags and FAQ JSON-LD to posts and pages." + } + } + ] +} +``` + +## Configuration & Developer Hooks + +The plugin provides filters and actions so developers can modify output or integrate with other plugins: + +- Filter `aseo_meta_title` — modify the computed SEO title +- Filter `aseo_meta_description` — modify the meta description +- Filter `aseo_faq_schema` — modify the generated FAQ JSON-LD array before encoding +- Action `aseo_faq_saved` — runs after FAQ entries are saved for a post + +Example (in your theme or plugin): + +```php +add_filter('aseo_meta_title', function($title, $post_id){ + return $title . ' | My Site'; +}, 10, 2); +``` + +## Changelog + +- 3.0.0 — Initial release: SEO title, meta description, Open Graph, FAQ builder, JSON-LD output + +## Support + +Open an issue in the repository or contact the maintainer for feature requests and bugs. ## Notes -The plugin is designed for posts and pages and works best when used alongside strong on-page content. The FAQ schema is especially useful for improving visibility in AI-driven search experiences. +- Designed for posts and pages. Best used alongside strong on-page content and standard SEO practices. +- FAQ schema helps AI-driven search experiences surface clear Q&A content. +