ailab

Readmo AI Plugin integrates seamlessly with the Readmo AI API service to bring intelligent article processing and question generation directly into your WordPress site.
<h3>Service Requirements</h3>
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.
<h3>Features</h3>
<ul>
<li>Easy Configuration – Simple setup with API Key and Sub Domain in the WordPress admin</li>
<li>Secure Storage – API keys encoded using Base64 for safe storage in WordPress options</li>
<li>Smart Question Generation – Automatically generates comprehension questions from any article URL</li>
<li>Real-time Processing – Monitor job status with 5-second polling intervals</li>
<li>Beautiful UI – Responsive button layout for question display</li>
<li>Multilingual Ready – Full translation support (i18n/l10n)</li>
<li>Shortcode Support – Use <code>[readmo_ai_articles]</code> to display on any page or post</li>
<li>CSRF Protection – Complete nonce verification on all forms and AJAX requests</li>
<li>Secure Architecture – WordPress Coding Standards compliant</li>
</ul>
<h3>How It Works</h3>
<ol>
<li>Configure your Readmo AI credentials in Settings > Readmo AI</li>
<li>Add the <code>[readmo_ai_articles]</code> shortcode to any page or post</li>
<li>The plugin automatically detects the current page URL</li>
<li>Questions are generated and displayed as interactive buttons</li>
<li>Clicking a button navigates to the question detail page on your Readmo AI subdomain</li>
</ol>
<h3>Shortcode Usage</h3>
Basic Usage: 
 <code>[readmo_ai_articles]</code>
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.
<h3>API Integration</h3>
The plugin connects to the Readmo AI API with the following endpoints:
<ul>
<li>GET /api/v1/api-key-info – Retrieve API key configuration and subdomain information</li>
<li>POST /api/v1/ArticleJobs – Create new article processing job</li>
<li>GET /api/v1/ArticleJobs/status – Check job processing status</li>
<li>GET /api/v1/Articles – Retrieve processed article with questions</li>
</ul>
All API requests are authenticated using your encoded API key and include comprehensive error handling with user-friendly messages.
<h3>Security</h3>
<ul>
<li>Base64 Encoding – API keys encoded for safe storage in WordPress options</li>
<li>Complete Nonce Verification – All AJAX requests and admin forms protected with WordPress nonce tokens</li>
<li>Input Validation – All user inputs sanitized using WordPress security functions</li>
<li>Output Escaping – All dynamic outputs escaped to prevent XSS attacks</li>
<li>CSRF Protection – Cross-Site Request Forgery protection on all forms</li>
<li>API Response Validation – Strict type checking and structure validation on all API responses</li>
<li>No Direct Database Access – Uses WordPress Options API exclusively</li>
</ul>
<h3>Requirements</h3>
<ul>
<li>WordPress 5.9 or higher</li>
<li>PHP 7.4 or higher</li>
<li>Active internet connection for API communication</li>
<li>Valid Readmo AI API credentials</li>
</ul>
<h3>Plugin Architecture</h3>
This plugin follows a modern four-layer architecture pattern for clean code separation and maintainability:
<ul>
<li>View Layer – Handles presentation templates and HTML output for user interfaces</li>
<li>Controller Layer – Processes HTTP requests, AJAX handling, and shortcode registration</li>
<li>Service Layer – Implements business logic and data validation, such as API key encoding</li>
<li>Infrastructure Layer – Manages data access and external API communication, including DAO and configuration</li>
</ul>
This architecture ensures: 
– Clear separation of concerns 
– Easy testing and maintenance 
– Scalability for future features 
– WordPress Coding Standards compliance
<h3>Configuration</h3>
In the plugin settings page (Settings > Readmo AI), configure:
<ul>
<li>API Key – Your Readmo AI API authentication key (encoded using Base64)</li>
</ul>
The API Key is encoded using Base64 before storage for safe storage in WordPress options. The encoded key is decoded when making API requests.
<h3>Troubleshooting</h3>
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 (<code>admin-ajax.php</code> 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
<h3>Privacy</h3>
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.
<h3>Credits</h3>
Built and maintained by the Readmo AI team.
Special thanks to: 
– WordPress community for coding standards and best practices
<h3>Support</h3>
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 support@readmo.ai
<h3>Third-Party Services</h3>
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.
<h3>License</h3>
This plugin is licensed under the GNU General Public License v2 or later.
<pre><code>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<h3>License Clarification</h3>
</code></pre>
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.

Readmo AI

AI-powered article analysis and intelligent question generation for WordPress. Requires Readmo AI API subscription.

Marinus Klasen

When i noticed i was setting up FAQ’s on multiple projects i decided to build an easy plugin for it. Simple and Small, but does what it needs to do.
First plugin that is submitted, but then again, it’s really simple so there can’t be that much bugs in it. 😉
If it’s getting used a lot, I will add new features; Always open for ideas!

mklasen's FAQ

Add easy Frequently Asked Questions to your WordPress website. Answers are shown (slide-down) after a visitor clicks on a question.

Readmo AI vs mklasen's FAQ