Readmo AI

Readmo AI Plugin integrates seamlessly with the Readmo AI API service to bring intelligent article processing and question generation directly into your WordPress site.

Service Requirements

This plugin is free and open source software (GPL v2 or later), but it requires:
– A paid subscription to Readmo AI API service
– Valid API credentials (API Key) from Readmo AI
– Active internet connection for API communication

The plugin code itself is completely free and you have full rights to modify and redistribute it under GPL v2 terms. However, without Readmo AI API access, the plugin will not be functional.

Features

• Easy Configuration – Simple setup with API Key and Sub Domain in the WordPress admin
• Secure Storage – API keys encoded using Base64 for safe storage in WordPress options
• Smart Question Generation – Automatically generates comprehension questions from any article URL
• Real-time Processing – Monitor job status with 5-second polling intervals
• Beautiful UI – Responsive button layout for question display
• Multilingual Ready – Full translation support (i18n/l10n)
• Shortcode Support – Use [readmo_ai_articles] to display on any page or post
• CSRF Protection – Complete nonce verification on all forms and AJAX requests
• Secure Architecture – WordPress Coding Standards compliant

How It Works

1. Configure your Readmo AI credentials in Settings > Readmo AI
2. Add the [readmo_ai_articles] shortcode to any page or post
3. The plugin automatically detects the current page URL
4. Questions are generated and displayed as interactive buttons
5. Clicking a button navigates to the question detail page on your Readmo AI subdomain

Shortcode Usage

Basic Usage:
[readmo_ai_articles]

The shortcode automatically detects the current page URL and sends it to the Readmo AI API for processing. Questions will be displayed as interactive buttons below the content.

API Integration

The plugin connects to the Readmo AI API with the following endpoints:

• GET /api/v1/api-key-info – Retrieve API key configuration and subdomain information
• POST /api/v1/ArticleJobs – Create new article processing job
• GET /api/v1/ArticleJobs/status – Check job processing status
• GET /api/v1/Articles – Retrieve processed article with questions

All API requests are authenticated using your encoded API key and include comprehensive error handling with user-friendly messages.

Security

• Base64 Encoding – API keys encoded for safe storage in WordPress options
• Complete Nonce Verification – All AJAX requests and admin forms protected with WordPress nonce tokens
• Input Validation – All user inputs sanitized using WordPress security functions
• Output Escaping – All dynamic outputs escaped to prevent XSS attacks
• CSRF Protection – Cross-Site Request Forgery protection on all forms
• API Response Validation – Strict type checking and structure validation on all API responses
• No Direct Database Access – Uses WordPress Options API exclusively

Requirements

• WordPress 5.9 or higher
• PHP 7.4 or higher
• Active internet connection for API communication
• Valid Readmo AI API credentials

Plugin Architecture

This plugin follows a modern four-layer architecture pattern for clean code separation and maintainability:

• View Layer – Handles presentation templates and HTML output for user interfaces
• Controller Layer – Processes HTTP requests, AJAX handling, and shortcode registration
• Service Layer – Implements business logic and data validation, such as API key encoding
• Infrastructure Layer – Manages data access and external API communication, including DAO and configuration

This architecture ensures:
– Clear separation of concerns
– Easy testing and maintenance
– Scalability for future features
– WordPress Coding Standards compliance

Configuration

In the plugin settings page (Settings > Readmo AI), configure:

• API Key – Your Readmo AI API authentication key (encoded using Base64)

The API Key is encoded using Base64 before storage for safe storage in WordPress options. The encoded key is decoded when making API requests.

Troubleshooting

Questions not displaying:
– Verify API Key is correct in Settings > Readmo AI
– Verify subdomain is configured via CNAME
– Check browser console for JavaScript errors (F12 > Console)
– Verify your Readmo AI account is active
– Check that the nonce is being passed correctly in AJAX requests

Slow processing:
– Processing time depends on article length and API load
– Large articles may take 30+ seconds to process
– The 5-second polling interval is optimal for most cases

API errors:
– 401 Unauthorized: API Key is invalid or expired
– 403 Forbidden: Account does not have permission for this resource
– 404 Not Found: Job ID or Article ID does not exist
– 429 Too Many Requests: API rate limit exceeded, wait and try again
– 500+ Server Error: Readmo AI service issue, contact support

Encoding errors:
– API keys are encoded using Base64 (no special PHP extensions required)
– Verify that data is being properly saved in WordPress options

AJAX not working:
– Verify WordPress AJAX is functioning (admin-ajax.php accessible)
– Check that JavaScript is not blocked by browser extensions
– Verify nonce tokens are being generated and validated
– Check PHP error logs for backend errors

Privacy

This plugin sends the following data to Readmo AI API (https://xlab-api.cmoney.tw/Readmore.ai.backend):
– Current page URL or custom URL (for article processing)
– Your encoded API Key (for authentication)
– Source type parameter (URL)

The plugin does NOT:
– Collect personal user data
– Track user behavior
– Store cookies
– Share data with third parties (except Readmo AI API)

All API communications are HTTPS-encrypted. For more details, see the Readmo AI Privacy Policy.

Credits

Built and maintained by the Readmo AI team.

Special thanks to:
– WordPress community for coding standards and best practices

Support

For support, feature requests, or bug reports:
– Documentation: Contact your Readmo AI account representative
– Technical Support: Readmo AI support team
– Security Issues: Report responsibly to [email protected]

Third-Party Services

This plugin connects to the Readmo AI API service:
– Service URL: https://xlab-api.cmoney.tw/Readmore.ai.backend/api
– Privacy Policy: Contact Readmo AI for details
– Terms of Service: Contact Readmo AI for details

By using this plugin, you agree to send article URLs to the Readmo AI service for processing.

License

This plugin is licensed under the GNU General Public License v2 or later.

Copyright (C) 2024 Readmo AI

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
License Clarification

Plugin Code: Free and open source (GPL v2 or later)
– You may freely use, modify, and redistribute this plugin code
– The source code is publicly available
– No restrictions on commercial or personal use of the plugin code

Readmo AI API Service: Paid subscription required
– The plugin connects to Readmo AI’s paid API service
– API access requires valid authentication credentials
– Service terms and pricing set by Readmo AI
– Plugin functionality depends on active API subscription

Your Rights Under GPL v2:
– Run the plugin for any purpose
– Study and modify the source code
– Redistribute copies of the plugin
– Distribute modified versions
– Use commercially without restrictions

What GPL v2 Does NOT Cover:
– Access to Readmo AI’s proprietary API service
– Readmo AI service subscription or pricing
– API authentication credentials
– Content generated by Readmo AI service

Important: While the plugin code is free under GPL v2, the Readmo AI API service is a separate commercial service with its own terms. You need both the free plugin AND a paid API subscription for the plugin to function.

1. Upload readmo-ai-plugin folder to /wp-content/plugins/ directory
2. Activate the plugin through the ‘Plugins’ menu in WordPress
3. Navigate to Settings > Readmo AI
4. Enter your API Key
5. Save settings
6. Use [readmo_ai_articles] shortcode on your pages

Is this plugin free?

Yes, this plugin is completely free and open source under GPL v2 or later license. You can:
– Download and use it for free
– Modify the source code
– Redistribute it to others
– Use it for commercial purposes

However, the plugin requires Readmo AI API service which is a paid subscription service. The plugin is the free “client”, but you need to pay for the “service” it connects to.

What is an API Key?

An API Key is a unique credential provided by Readmo AI that authenticates your WordPress site with the Readmo AI service. You must have a paid Readmo AI subscription to obtain an API key. Contact Readmo AI support to purchase a subscription and get your API credentials.

Is my API Key secure?

Yes. API keys are encoded using Base64 encoding and stored securely in the WordPress database. The encoded data is only decoded when making API requests. We recommend using HTTPS for your WordPress site to ensure all data transmission is encrypted.

Can I use the plugin on multiple sites?

Each WordPress site requires its own API Key from Readmo AI. You can configure different credentials for each site.

What happens if the API is unavailable?

The plugin displays a user-friendly error message. Common HTTP status codes are mapped to helpful messages (401, 403, 404, 429, 500+). The plugin will stop polling and display the error to prevent unnecessary requests.

How often are questions updated?

Questions are generated fresh each time a new article URL is processed. The plugin creates a job, polls for completion, and caches the article ID. Subsequent loads with the same URL will use the cached article ID.

Can I customize the button styling?

Yes. CSS classes are applied to all elements:
– .readmo-ai-container – Main container
– .readmo-ai-questions – Questions wrapper
– .readmo-ai-question-btn – Individual question buttons

You can override these styles in your theme’s CSS.

Is the plugin translated?

The plugin is translation-ready with the text domain readmo-ai. All user-facing strings use WordPress i18n functions (__(), _e(), esc_html__()). Translations can be added via:
– WordPress.org translation system
– .po/.mo files in /languages/ directory
– Translation plugins like Loco Translate

What is the polling interval?

The plugin checks job processing status every 5 seconds until the job is completed or failed. This interval provides a good balance between responsiveness and server load.

Are there any usage limits?

Limits depend on your Readmo AI service plan. The API may enforce rate limits (HTTP 429 status). Check your API documentation or contact support for details.

How does the shortcode work?

The [readmo_ai_articles] shortcode automatically detects the current page URL where it’s placed and sends it to the Readmo AI API. The URL cannot be manually specified – it always uses the page where the shortcode is embedded. This ensures questions are always relevant to the current content.

Does the plugin cache results?

The plugin does not implement caching in version 1.0.0. Each page load with the shortcode creates a new job request to ensure fresh content. Caching functionality is planned for a future release.

1.0.0 (2025-11-10)

• Initial public release
• Core Features:
  • Complete API integration (ArticleJobs, ArticleJobs/status, Articles, api-key-info endpoints)
  • Base64 encoding for API key storage
  • Real-time job polling with 5-second intervals
  • Shortcode support with auto URL detection
  • Responsive question button UI
  • AJAX-based frontend processing
• Security:
  • Complete nonce verification on all forms and AJAX requests
  • Input sanitization with WordPress security functions
  • Output escaping to prevent XSS
  • CSRF protection on admin forms
  • Comprehensive API response validation
• Compliance:
  • WordPress Coding Standards compliant (WPCS)
  • PHPDoc documentation on all classes and methods
  • Full translation support (i18n/l10n)
  • Follows WordPress Plugin Handbook guidelines
• Error Handling:
  • User-friendly error messages for all HTTP status codes
  • Comprehensive debugging support