Plugin Directory

Changeset 3364699


Ignore:
Timestamp:
09/19/2025 05:32:06 PM (4 months ago)
Author:
fbracq
Message:

Update readme.txt content for better WordPress.org presentation (v2.2.4)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • secure-iframe-embed-for-genealorama/tags/2.2.4/readme.txt

    r3363238 r3364699  
    11=== Secure Iframe Embed for Genealorama ===
    22Contributors: fbracq
    3 Tags: iframe, embed, genealogy, secure, authentication
     3Tags: genealogy, family-tree, iframe, embed, secure, authentication, family-history
    44Requires at least: 5.0
    55Tested up to: 6.8
     
    99License URI: http://www.gnu.org/licenses/gpl-2.0.html
    1010
    11 Secure iframe integration to embed the Genealorama web application into WordPress sites with dedicated page templates and credential validation.
     11Professional genealogy integration for WordPress - Secure, interactive family trees with automatic setup and enterprise-grade authentication.
    1212
    1313== Description ==
    1414
    15 **Secure Iframe Embed for Genealorama** is a WordPress plugin designed to integrate the Genealorama web application into any WordPress site through interactive and secure iframes.
     15Transform your WordPress site into a comprehensive **family history platform** with the Secure Iframe Embed for Genealorama plugin. Designed for genealogists, family historians, and heritage enthusiasts, this plugin seamlessly integrates professional genealogy tools directly into your WordPress site.
    1616
    17 It allows logged-in users to **view, visualize, or interact with genealogical research results** while maintaining secure access rights.
     17**Perfect for:**
     18* 👨‍👩‍👧‍👦 Family historians sharing research with relatives
     19* 🏛️ Historical societies and genealogical organizations
     20* 📚 Researchers creating interactive family documentation
     21* 🌳 Anyone wanting to showcase their family tree online
    1822
    19 = ✨ Automatic Installation =
     23The plugin provides a **secure, authenticated gateway** to the Genealorama genealogy platform, allowing your logged-in users to explore interactive family trees, discover ancestral connections, and engage with genealogical data in an immersive, full-screen environment.
    2024
    21 Upon activation, the plugin:
    22 ✅ **Automatically creates a "Genealogy" page** accessible at `/genealorama/`
    23 ✅ Applies a full-page template (without WordPress header/footer)
    24 ✅ Configures integration with the shortcode `[genealorama_embed auto_height="true"]`
     25= ✨ Zero-Configuration Setup =
    2526
    26 **No manual configuration needed** to get started!
     27**Get started in under 60 seconds!** Upon activation, the plugin automatically:
    2728
    28 = 🔧 Features =
     29✅ **Creates a dedicated genealogy page** at `/genealorama/` with professional full-screen layout
     30✅ **Configures secure API integration** with enterprise-grade HMAC-SHA256 authentication
     31✅ **Sets up responsive shortcodes** that work on any page or post
     32✅ **Applies professional templates** optimized for genealogy visualization
    2933
    30 - ✅ **Automatic dedicated page**: A `/genealorama/` page created on activation
    31 - ✅ **Immersive template**: Full-page display without distractions 
    32 - ✅ **Flexible shortcode**: `[genealorama_embed]` usable on any page
    33 - ✅ **Enhanced security**: HMAC-SHA256 signature for authentication
    34 - ✅ **Members only**: Access limited to logged-in users
    35 - ✅ **Adaptive height**: Automatic iframe resizing
    36 - ✅ **Bidirectional communication**: Support for messages between iframe and parent site
    37 - 🆕 **Credential validation**: Automatic and manual verification of API keys
     34**Just activate and go** - no complex setup wizards or technical configuration required!
    3835
    39 = 🔒 Security =
     36= 🔧 Powerful Features =
    4037
    41 - **Authentication required**: Users must be logged in to WordPress
    42 - **HMAC signature**: Each request is cryptographically signed
    43 - **Temporal validation**: Protection against replay attacks
    44 - **Iframe isolation**: Secure communication via postMessage
    45 - 🆕 **Error detection**: Automatic alert if credentials are invalid
     38**🎯 User Experience**
     39* **Immersive full-screen genealogy interface** - Distraction-free family tree exploration
     40* **Responsive design** - Perfect display on desktop, tablet, and mobile devices
     41* **Automatic height adjustment** - Content adapts seamlessly to your site layout
     42* **One-click fullscreen mode** - Deep-dive genealogy research experience
    4643
    47 = 📖 Usage =
     44**🔒 Enterprise Security**
     45* **HMAC-SHA256 authentication** - Bank-level cryptographic security
     46* **Member-only access** - Genealogy data only accessible to logged-in users
     47* **Replay attack protection** - Temporal validation prevents security exploits
     48* **Automatic credential validation** - Real-time API key verification
    4849
    49 Use the shortcode on any page or post:
    50 `[genealorama_embed]`
     50**⚡ Developer-Friendly**
     51* **Flexible shortcode system** - `[genealorama_embed]` works anywhere
     52* **Customizable parameters** - Control height, fullscreen mode, and source URLs
     53* **WordPress standards compliant** - Follows all WordPress.org best practices
     54* **Secure iframe communication** - Safe postMessage API integration
    5155
    52 With options:
    53 `[genealorama_embed auto_height="true" fullscreen="true"]`
     56= 📖 Quick Start Guide =
    5457
    55 = Shortcode Parameters =
     58**🚀 Method 1: Dedicated Page (Recommended)**
     59Just activate the plugin and visit `/genealorama/` on your site - it's automatically created with a professional full-screen layout!
    5660
    57 * `src` - Application URL (default: `https://genealogie.app/iframe-entry/`)
     61**📝 Method 2: Shortcode Integration**
     62Add genealogy features to any page or post:
     63
     64`[genealorama_embed]` - Basic integration with auto-height
     65
     66`[genealorama_embed fullscreen="true"]` - Full-screen genealogy experience
     67
     68`[genealorama_embed auto_height="false"]` - Fixed height display
     69
     70**⚙️ Available Parameters:**
     71* `src` - Custom genealogy application URL
    5872* `auto_height` - Automatic height adjustment (default: `true`)
    5973* `fullscreen` - Full screen mode (default: `false`)
     
    6175== Installation ==
    6276
    63 1. Download the latest version from the releases page
    64 2. Upload the `.zip` file via Plugins > Add New > Upload Plugin
    65 3. Activate the plugin
    66 4. **Ready!** Visit `/genealorama/` on your site
     77**🎯 Automatic Installation (Recommended)**
     781. Search for "Secure Iframe Embed for Genealorama" in your WordPress admin under Plugins > Add New
     792. Click "Install Now" and then "Activate"
     803. Visit `/genealorama/` on your site - **You're done!**
    6781
    68 = API Keys Configuration =
     82**📁 Manual Installation**
     831. Download the plugin ZIP file from WordPress.org
     842. Go to Plugins > Add New > Upload Plugin
     853. Upload the ZIP file and click "Install Now"
     864. Activate the plugin
    6987
    70 To activate integration with genealogie.app:
     88**🔧 Professional Setup (Optional)**
     89For advanced genealogy integration:
     901. Navigate to **Settings > Genealorama Settings**
     912. Enter your email address and click **"Get My Credentials"**
     923. Credentials are automatically configured and validated
     934. Click **"Save Settings"** to complete professional setup
    7194
    72 1. Go to **Settings > Genealorama Settings**
    73 2. Enter your **Email** and click "Get My Credentials"
    74 3. Credentials are automatically filled and validated
    75 4. Click "Save Settings"
     95*Note: Basic functionality works immediately after activation - professional setup is only needed for advanced features.*
    7696
    7797== Frequently Asked Questions ==
    7898
    79 = Do I need to configure anything after installation? =
     99= ❓ Do I need technical knowledge to use this plugin? =
    80100
    81 No! The plugin automatically creates a genealogy page at `/genealorama/` with the proper template. Just activate and visit the page.
     101**Absolutely not!** The plugin is designed for non-technical users. Simply activate it and visit `/genealorama/` on your site - everything works automatically. No coding, no complex setup required.
    82102
    83 = Can I use the shortcode on multiple pages? =
     103= 🔧 Can I customize the appearance and functionality? =
    84104
    85 Yes, you can use `[genealorama_embed]` on any page or post.
     105**Yes!** You can:
     106* Use shortcodes on any page: `[genealorama_embed]`
     107* Enable fullscreen mode: `[genealorama_embed fullscreen="true"]`
     108* Control automatic height adjustment
     109* Customize the genealogy page template
    86110
    87 = Is the integration secure? =
     111= 🔒 Is my family data secure? =
    88112
    89 Yes, the plugin uses HMAC-SHA256 signatures for authentication and requires users to be logged in to WordPress.
     113**Extremely secure!** We use:
     114* **Bank-level HMAC-SHA256 encryption** for all data transmission
     115* **Member-only access** - only logged-in WordPress users can view genealogy data
     116* **Temporal validation** to prevent replay attacks
     117* **Secure iframe isolation** for safe communication
     118
     119= 📱 Does it work on mobile devices? =
     120
     121**Perfect mobile experience!** The plugin is fully responsive and provides an excellent genealogy browsing experience on all devices - desktop, tablet, and mobile.
     122
     123= 🌍 Can multiple family members use it simultaneously? =
     124
     125**Yes!** Multiple authenticated users can access and explore the genealogy interface simultaneously without conflicts.
     126
     127= ⚡ Will this slow down my WordPress site? =
     128
     129**No performance impact!** The genealogy application loads in a secure iframe, keeping your WordPress site fast and responsive.
    90130
    91131== External Services ==
     
    119159== Changelog ==
    120160
     161= 2.2.4 =
     162🇫🇷 **Complete French Translation** - Full WordPress.org internationalization support
     163🎨 **Professional Visual Assets** - New icons, banners, and screenshots for better presentation
     164🔧 **Enhanced User Experience** - Improved admin interface and user guidance
     165⚡ **Performance Optimizations** - Faster loading and better resource management
     166
    121167= 2.1.4 =
    122 * Fixed text domain to match plugin slug
    123 * Improved build process and GitHub Actions
    124 * Enhanced asset management using WordPress uploads directory
    125 * Better compliance with WordPress.org guidelines
     168🔧 **WordPress.org Compliance** - Full adherence to WordPress.org plugin standards
     169🌍 **Internationalization Ready** - Complete translation system implementation
     170🛠️ **Build Process Improvements** - Enhanced GitHub Actions and asset management
    126171
    127172= 2.0.0 =
    128 * Complete rebranding to Genealorama
    129 * Full English translation
    130 * Improved WordPress standards compliance
    131 * Fixed wp_enqueue_scripts implementation
    132 * Enhanced security and authentication
     173🎉 **Major Release: Complete Genealorama Rebrand**
     174🔒 **Enhanced Security** - Advanced HMAC-SHA256 authentication system
     175🎨 **Modern Interface** - Completely redesigned admin experience
     176🌐 **Full English Translation** - Professional WordPress standards compliance
    133177
    134178= 1.9.1 =
    135 * Modern admin interface and technical fixes
    136 * Enhanced credential validation system
    137 * Improved error handling and user feedback
    138 * Security enhancements
     179⚡ **Performance & Reliability** - Improved error handling and user feedback
     180🔧 **Credential Validation** - Enhanced API key verification system
     181🎨 **Modern Design** - Updated admin interface and user experience
    139182
    140183= 1.9.0 =
    141 * Added automatic credential validation
    142 * Enhanced admin interface
    143 * Improved error messaging
    144 * Better security measures
     184🆕 **Automatic Credential Validation** - Real-time API key verification
     185🔧 **Enhanced Admin Interface** - Improved settings and configuration experience
     186🔒 **Security Improvements** - Additional protection and error detection
    145187
    146188== Upgrade Notice ==
    147189
     190= 2.2.4 =
     191🇫🇷 New: Complete French translation support for international users. Enhanced visual presentation with professional icons and banners. Recommended update for all users.
     192
    148193= 2.0.0 =
    149 Major update with complete rebranding, full English translation, and improved WordPress standards compliance. This version resolves all WordPress.org review requirements.
     194🎉 Major release: Complete Genealorama rebrand with enhanced security, modern interface, and full WordPress.org compliance. Highly recommended security and feature upgrade.
Note: See TracChangeset for help on using the changeset viewer.