Changeset 3305965

Timestamp:

06/03/2025 05:46:33 PM (7 months ago)

Author:

webcava

Message:

New improvements

File:

• suggester/trunk/readme.txt (modified) (3 diffs)

suggester/trunk/readme.txt

@@ -1 +1 @@
 === Suggester ===
 Contributors: webcava
-Tags: suggestions, search, gemini, ai, content suggestions
+Tags: ai, suggestions, content generator, gemini, openrouter
 Requires at least: 5.0
 Tested up to: 6.8
-Stable tag: 1.0.0
-Requires PHP: 7.2
+Stable tag: 1.0.1
+Requires PHP: 8.0
 License: GPLv2 or later
 License URI: https://www.gnu.org/licenses/gpl-2.0.html
 
-Suggester helps your website visitors find what they're looking for with AI-powered content suggestions.
+An intelligent suggestion generator based on keywords using Google Gemini and OpenRouter APIs.
 
 == Description ==
 
-Suggester is a powerful WordPress plugin that enhances user experience by providing intelligent content suggestions. Using Google's Gemini AI technology, Suggester analyzes user queries and delivers relevant content recommendations, helping visitors find exactly what they're looking for.
+Suggester is a powerful WordPress plugin that allows site owners to create intelligent suggestion tools powered by AI. Using Google Gemini and OpenRouter APIs, the plugin generates content suggestions based on user-entered keywords.
 
 = Key Features =
 
-* **Easy Integration**: Add suggestion widgets to any page or post using simple shortcodes
-* **Customizable Design**: Adjust colors, layout, and text to match your website's design
-* **Detailed Statistics**: Track usage and see how visitors interact with your suggestions
-* **Multiple Widgets**: Create up to 3 different suggestion widgets (unlimited in PRO version)
-* **Google Gemini AI**: Powered by Google's advanced AI technology for intelligent suggestions
+* Create up to 3 custom suggestion tools
+* Each tool has its own shortcode for easy embedding
+* Customizable prompts and output format
+* Statistics tracking for usage
+* Advanced API key management
+
+= External Services =
+
+This plugin connects to the following external services:
+
+* Google Gemini API: Used to generate AI-powered suggestions. [Terms of Use](https://policies.google.com/terms), [Privacy Policy](https://policies.google.com/privacy)
+* OpenRouter API: Provides access to multiple AI models. [Terms of Use](https://openrouter.ai/terms), [Privacy Policy](https://openrouter.ai/privacy)
 
 = How It Works =
 
-1. Add a Suggester widget to your pages using the provided shortcode
-2. Visitors enter their search queries in the widget
-3. Suggester processes the query using Google Gemini AI and displays relevant suggestions
-4. Visitors can save their favorite suggestions for later reference
-
-= Use Cases =
-
-* **E-commerce**: Help shoppers find products they're interested in
-* **Content Sites**: Guide readers to relevant articles and resources
-* **Documentation**: Assist users in finding the right help documentation
-* **Support**: Direct users to appropriate support resources
-
-= Privacy Notice =
-
-The free version of Suggester tracks basic usage statistics to help us improve the plugin. No personal data is collected. Our privacy policy is available in the plugin's admin area.
-
-== External Services ==
-
-This plugin connects to Google's Gemini AI API to generate intelligent content suggestions based on user input.
-
-**Service:** Google Gemini AI API
-**Purpose:** Generate AI-powered content suggestions and recommendations based on user search queries
-**Data Sent:** User search terms/keywords and custom prompts (if configured by the site administrator)
-**When:** Every time a visitor requests suggestions through the widget by entering a search term and clicking the suggestion button
-**API Endpoint:** https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:generateContent
-
-**Requirements:** You need a Google API key to use this service. By using this plugin, you acknowledge that user search data will be transmitted to Google's servers for processing.
-
-**Important Links:**
-* Google AI Terms of Service: https://ai.google.dev/terms
-* Google Privacy Policy: https://policies.google.com/privacy
-* Google AI Studio (to get API key): https://aistudio.google.com/
-
-**Data Privacy:** Search terms entered by your website visitors are sent to Google's API for processing. Please ensure you comply with applicable privacy laws and inform your users about this data transmission in your privacy policy.
+1. The site owner creates a custom tool with a specific prompt template
+2. The tool is embedded on any page using a shortcode (e.g., [suggester id='1'])
+3. Visitors enter keywords in the tool's input field
+4. The plugin sends the keywords and prompt to the AI service
+5. Results are displayed instantly on the page
 
 == Installation ==
@@ -64 +42 @@
 1. Upload the `suggester` folder to the `/wp-content/plugins/` directory
 2. Activate the plugin through the 'Plugins' menu in WordPress
-3. Go to Suggestor > Settings to configure your Google Gemini API key
-4. Create your first widget through Suggestor > Widgets
-5. Add the widget to your site using the provided shortcode
+3. Go to the Suggester dashboard to configure your API keys
+4. Create your first suggestion tool
+5. Use the provided shortcode to add the tool to any page
 
 == Frequently Asked Questions ==
 
-= Do I need an API key to use Suggester? =
+= How many tools can I create? =
 
-Yes, Suggester uses Google's Gemini AI API which requires an API key. You can get a free API key from Google AI Studio.
+The free version allows you to create up to 3 tools, each with its own unique shortcode.
 
-= How do I add a Suggester widget to my page? =
+= Do I need to have API keys to use this plugin? =
 
-After creating a widget in the Suggester > Widgets section, you can add it to any page or post using the shortcode provided. For example: `[suggestor id='1']`
+Yes, you need to have either a Google Gemini API key or an OpenRouter API key (or both) to use this plugin.
 
-= Can I customize the appearance of the widget? =
+= What information is sent to the external APIs? =
 
-Yes, you can customize colors, text, layout, and more through the widget settings.
+The plugin sends the keyword entered by the user, along with the prompt template you've configured. No personal user data is sent to the APIs.
 
-= How many widgets can I create? =
+= Is this plugin compatible with multilingual sites? =
 
-The free version allows you to create up to 3 widgets. The PRO version offers unlimited widgets.
-
-= What data does Suggester collect? =
-
-The free version only collects anonymous usage statistics to help us improve the plugin. No personal data is collected or stored.
-
-= Is Suggester compatible with my theme? =
-
-Suggester is designed to be compatible with most WordPress themes. The widgets use responsive design and adapt to your site's layout.
+Yes, the plugin fully supports translation, including right-to-left (RTL) languages like Arabic.
 
 == Screenshots ==
 
-1. Suggester widget on a website
-2. Admin dashboard with statistics
-3. Widget customization options
-4. Suggestion history page
+1. Dashboard Overview
+2. Creating a new suggestion tool
+3. Frontend tool display
+4. Settings page
 
 == Changelog ==
+
+= 1.0.1 =
+* New improvements
 
 = 1.0.0 =
@@ -107 +80 @@
 
 == Upgrade Notice ==
+Please update to the latest version 1.0.1 to get more new features.
 
-= 1.0.0 =
-Initial release of Suggester plugin.
+= 1.0.1 =
+New improvements
 
 == Privacy Policy ==
 
-Suggester respects your privacy and the privacy of your website visitors. Here's how we handle data:
+Suggester uses external AI services to generate suggestions. When a user enters a keyword, that keyword along with your configured prompt template is sent to either the Google Gemini API or OpenRouter API (depending on your settings). We do not collect or store personal information about your users, but the external services may have their own privacy policies regarding how they handle the data sent to them.
 
-= Data Collection =
-
-* **Usage Statistics**: The free version only collects anonymous usage statistics (counts and timestamps) to help us improve the plugin.
-* **Search Terms**: The free version does NOT store the actual search terms entered by your users in your WordPress database.
-* **User IDs**: We store a reference to the WordPress user ID (if logged in) for statistical purposes only.
-
-= External API Usage =
-
-* **Google Gemini API**: Suggester uses Google's Gemini API to generate content suggestions.
-* **Data Transmission**: When a user enters a search term, it is sent to Google's Gemini API using your API key.
-* **Google's Data Handling**: Google may store and process this data according to their terms of service.
-* **Your Responsibility**: As the website owner, you are responsible for ensuring your use of the Google Gemini API complies with their terms of service and that you have informed your users about how their data is processed.
-
-= Data Removal =
-
-* All plugin data is automatically removed when you uninstall the plugin.
-* No data is retained on our servers as all processing happens on your WordPress site and Google's servers.
-
-For more information about our privacy policy and Google's terms of service, please refer to the plugin's admin area.
+For more information about how these services handle data, please refer to their respective privacy policies:
+* Google Gemini: https://policies.google.com/privacy
+* OpenRouter: https://openrouter.ai/privacy