RELEASE NOTES - Knova 1.0.0
============================

Stable Release

This is the first stable release of Knova, an AI-powered chatbot widget for Drupal.

WHAT'S NEW IN 1.0.0
-------------------
- Stable release with all critical bugs fixed
- Improved security and XSS protection
- Better PHP 8.1+ compatibility
- Enhanced error handling and input validation
- Improved session management using Drupal's session service
- Better cache handling with proper cache tags
- Fixed widget duplication issues
- Enhanced CSS value validation and escaping
- Better JSON error handling
- Improved documentation

UPGRADE FROM BETA
-----------------
If you're upgrading from 1.0.0-beta1:
1. Backup your database
2. Disable the module at /admin/modules
3. Replace the module files with the new version
4. Re-enable the module
5. Clear all caches (drush cr or Configuration > Performance > Clear all caches)
6. Review your settings at /admin/config/services/knova
7. Test the widget functionality

INSTALLATION
------------
1. Download and extract the module to your modules directory (modules/custom/ or modules/contrib/)
2. Enable the module at /admin/modules
3. Configure at /admin/config/services/knova
4. Add your OpenAI API key
5. Train the chatbot with Q&A pairs based on your website content
6. Customize the widget appearance
7. The widget will appear automatically on your site

REQUIREMENTS
------------
- Drupal 10.x or 11.x
- PHP 7.4 or higher (PHP 8.1+ recommended)
- OpenAI API key (sign up at https://platform.openai.com/)

FEATURES
--------
- Floating chat widget with Intercom-like design
- OpenAI API integration (GPT-4, GPT-3.5, custom models)
- Custom Q&A pair training system
- Full visual customization (colors, positioning, dimensions, branding)
- Lead capture and inquiry management
- Multiple conversation storage options (localStorage, database, session)
- Rate limiting for API cost control
- Mobile responsive design
- CSRF protection and security best practices
- Comprehensive admin configuration interface
- Block plugin for flexible placement

CONFIGURATION
-------------
After installation, navigate to Configuration > Services > Knova Settings to:
- Configure your OpenAI API key and endpoint
- Set up system prompts for the AI
- Add custom Q&A pairs for training
- Customize widget appearance (colors, position, size)
- Configure conversation storage options
- Set up rate limiting
- Manage inquiries

WIDGET PLACEMENT
----------------
The widget can be displayed in two ways:
1. Automatic (via hook): The widget automatically appears on all pages (except admin pages)
2. Block Placement: Use the "Knova Widget" block plugin to place the widget in specific regions

SUPPORT
-------
Report issues at: https://www.drupal.org/project/issues/knova

CHANGELOG
---------
See CHANGELOG.txt for detailed list of changes.

