=== MW LLMS Index ===
Contributors: mohamedwazery
Donate link: https://wazery.net/donate
Tags: ai, llms-txt, seo, sitemap, index, content-index
Requires at least: 5.5
Tested up to: 6.9
Requires PHP: 7.4
Stable tag: 1.0.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Generate AI-friendly llms.txt and llms.json index files to help AI systems discover and understand your WordPress content.

== Description ==

MW LLMS Index is a WordPress plugin that automatically generates AI-friendly index files for your website. It creates `llms.txt` (plain text) and `llms.json` (structured JSON) files inside `wp-content/uploads/mw-llm-index/`, making it easy for AI systems to discover and understand your content.

**Key Features:**

* **Automatic Index Generation**: Automatically generates `llms.txt` and `llms.json` files with all your published posts and pages
* **SEO Plugin Integration**: Seamlessly integrates with popular SEO plugins (Rank Math, Yoast SEO, All in One SEO) to use meta descriptions
* **Flexible Scheduling**: Choose from daily, weekly, or manual regeneration schedules using WP Cron
* **AI Bot Logging**: Optional logging of AI bot visits (GPTBot, ClaudeBot, PerplexityBot) to track when AI systems access your site
* **REST API Access**: Access your index data programmatically via WordPress REST API
* **Auto-Generation**: Automatically creates files on activation if they don't exist
* **Clean Uninstall**: Removes all generated files and settings when uninstalled

**Technical Features:**

* ✔ **WP Cron Integration**: Uses WordPress built-in cron system for scheduled updates
* ✔ **Editor Compatibility**: Works seamlessly with both Gutenberg and Classic Editor
* ✔ **Zero Frontend Assets**: No JavaScript or CSS files loaded on the frontend - lightweight and fast
* ✔ **WordPress Standards**: Follows WordPress coding standards and best practices
* ✔ **Multisite Compatible**: Works on single-site and multisite installations

**What is llms.txt?**

The `llms.txt` file is a standardized format for providing AI systems with a structured index of your website's content. It helps AI models like ChatGPT, Claude, and Perplexity understand what content is available on your site and how to access it.

**How It Works:**

1. The plugin scans all published posts and pages on your WordPress site
2. Extracts titles, URLs, and descriptions (from SEO plugins when available)
3. Generates two files:
   * `llms.txt` - Human-readable plain text format
   * `llms.json` - Machine-readable JSON format for programmatic access
4. Files are automatically updated based on your chosen schedule

**Use Cases:**

* Help AI systems discover and index your content
* Improve AI model understanding of your website structure
* Provide structured content metadata for AI training
* Track when AI bots visit your site
* Export your content index for external use

**Useful Links:**

* [Documentation](https://github.com/mohamedwazery/mw-llms-index/wiki)
* [Report Issues](https://github.com/mohamedwazery/mw-llms-index/issues)
* [GitHub Repository](https://github.com/mohamedwazery/mw-llms-index)

== Installation ==

**Automatic Installation:**

1. Log in to your WordPress admin panel
2. Go to Plugins → Add New
3. Search for "MW LLMS Index"
4. Click "Install Now" then "Activate"

**Manual Installation:**

1. Download the plugin zip file
2. Upload the `mw-llms-index` folder to `/wp-content/plugins/`
3. Activate the plugin through the 'Plugins' menu in WordPress

**After Activation:**

1. Go to Settings → MW LLMS Index
2. Choose your preferred schedule (Daily/Weekly/Manual)
3. Click "Save Settings & Regenerate Now"
4. Verify files at: `wp-content/uploads/mw-llm-index/llms.txt`

The plugin will automatically create `llms.txt` and `llms.json` files inside `wp-content/uploads/mw-llm-index/`.

== Frequently Asked Questions ==

= What files does this plugin create? =

The plugin creates two files inside the uploads directory (`wp-content/uploads/mw-llm-index/`):
* `llms.txt` - Plain text index of your content
* `llms.json` - Structured JSON index for programmatic access

= Where are the files located? =

Both files are created inside the uploads directory (the same location WordPress uses for media uploads), under `wp-content/uploads/mw-llm-index/`.

= How can I view the generated files? =

You can access the files directly via URLs:
* Plain text: `https://yoursite.com/wp-content/uploads/mw-llm-index/llms.txt`
* JSON format: `https://yoursite.com/wp-content/uploads/mw-llm-index/llms.json`
* REST API: `https://yoursite.com/wp-json/mw-llms/v1/index`

= Can I customize which posts are included? =

Currently, the plugin includes all published posts and pages. Future versions may include filtering options.

= Does this work with custom post types? =

Currently, the plugin includes standard posts and pages. Support for custom post types may be added in future versions.

= How often are the files updated? =

You can choose from:
* Daily - Files are regenerated once per day
* Weekly - Files are regenerated once per week
* Manual - Files are only regenerated when you click the button

= What SEO plugins are supported? =

The plugin integrates with:
* Rank Math
* Yoast SEO
* All in One SEO (AIOSEO)

If no SEO plugin is detected, it falls back to using post excerpts.

= Can I access the index via API? =

Yes! The plugin provides a REST API endpoint at `/wp-json/mw-llms/v1/index` that returns the JSON index data.

= What is AI bot logging? =

When enabled, the plugin logs visits from AI bots (GPTBot, ClaudeBot, PerplexityBot) to a file at `wp-content/uploads/mw-llm-index/mw_llms_bot_log.txt`. This helps you track when AI systems access your site.

= Will this affect my site's performance? =

The plugin is lightweight and only runs during file generation (scheduled or manual). The logger only runs when enabled and only checks user agents, so performance impact is minimal.

= What happens when I uninstall the plugin? =

All generated files (`llms.txt`, `llms.json`, and bot log files) are automatically deleted, along with all plugin settings.

== Screenshots ==

1. Main settings page - Configure schedule, SEO integration, and bot logging
2. Example of generated llms.txt file with post titles and URLs
3. JSON index structure showing metadata and content organization

== Changelog ==

= 1.0.0 =
* Initial release
* Automatic generation of llms.txt and llms.json files
* Integration with popular SEO plugins
* Flexible scheduling (daily, weekly, manual)
* AI bot logging functionality
* REST API endpoint for programmatic access
* Auto-generation on activation
* Clean uninstall functionality

== Upgrade Notice ==

= 1.0.0 =
First release! Generate AI-ready index files, integrate with SEO plugins, schedule automatic updates, and track AI bot visits. Install now to make your content AI-discoverable.

== External Services ==

This plugin does NOT connect to any external services or APIs. All data is:
* Generated locally on your WordPress server
* Stored in your uploads directory
* Accessible only through your own domain
* Not transmitted to third parties

The plugin is completely self-contained and operates entirely within your WordPress installation.

== Support ==

For support, feature requests, or bug reports, please visit:
* [GitHub Issues](https://github.com/mohamedwazery/mw-llms-index/issues)
* [WordPress.org Support Forum](https://wordpress.org/support/plugin/mw-llms-index/)

== Credits ==

Developed by Mohamed Khalil Wazery
Website: https://wazery.net

== Privacy ==

This plugin:
* Does not collect any user data
* Does not send data to external servers
* Only generates files locally on your WordPress installation
* Optionally logs AI bot visits locally (can be disabled)
* Does not use cookies
* Does not track users

The generated `llms.txt` and `llms.json` files are publicly accessible (located in `wp-content/uploads/mw-llm-index/`) and contain information about your published content, similar to what would be available in your sitemap.

== Security Notes ==

**Important Security Information:**

This plugin does not expose private data and only outputs publicly available content, similar to a sitemap. The generated files contain:
* Only published posts and pages (same visibility as your public website)
* Titles, URLs, and meta descriptions (already publicly accessible)
* No private user information
* No sensitive data or credentials

The files are placed in `wp-content/uploads/mw-llms-index/` and are publicly accessible, but they only contain information that is already available on your public website. If you have concerns about specific content being indexed, ensure those posts/pages are set to private or draft status.
