WordPress.org
Get WordPress

Plugin Directory

Changeset 3475072


Ignore:
Timestamp:
03/05/2026 01:55:59 AM (3 weeks ago)
Author:
XpertOne
Message:

Update readme.txt in 2.0.0 tag: rewrite for clarity, SEO, and professional formatting

File:
1 edited

Legend:

Unmodified
Added
Removed

  • match-me-for-buddypress/tags/2.0.0/readme.txt

    r3475047 r3475072  
    11=== Match Me for BuddyPress & BuddyBoss ===
    22Contributors: xpertone
    3 Tags: buddypress, buddyboss, matchmaking, compatibility, member directory
     3Tags: buddypress, buddyboss, matchmaking, compatibility, member matching
    44Requires at least: 5.9
    55Tested up to: 6.9
    … …  
    99License URI: https://www.gnu.org/licenses/gpl-2.0.html
    1010
    11 Turn your BuddyPress or BuddyBoss community into a matchmaking platform with weighted scoring and smart comparison modes.
     11Turn your BuddyPress or BuddyBoss community into a matchmaking platform with weighted compatibility scoring, smart comparison modes, and automatic member matching.
    1212
    1313== Description ==
    1414
    15 **Match Me for BuddyPress & BuddyBoss** turns any BuddyPress or BuddyBoss community into a matchmaking platform. Members see compatibility scores based on their profile fields, weighted and scored using smart comparison modes.
     15**Match Me for BuddyPress & BuddyBoss** is a compatibility matching plugin that calculates how well members align based on their profile fields. Whether you are building a dating site, a networking community, a roommate finder, a mentor matching platform, or any community where connecting the right people matters, Match Me gives every member pair a compatibility percentage they can see on profiles and the members directory.
    1616
    17 = 🚀 How It Works =
     17You choose which xProfile fields to include, how much each one matters, and how values should be compared. The plugin handles the rest: scoring, caching, and displaying results automatically across your site.
    1818
    19 1. **Configure fields** in the admin by assigning weights and comparison modes to your xProfile fields
    20 2. **Members browse** and match percentages appear automatically on profiles and the members directory
    21 3. **Smart caching** stores results in a dedicated table and recalculates only when profiles change
     19**Works with BuddyPress and BuddyBoss Platform.** The plugin auto detects which one is active. No configuration needed.
    2220
    23 = ✨ Core Features =
     21= 🔧 How It Works =
    2422
    25 🎯 **Weighted matching engine** Assign a percentage weight to each xProfile field. Fields that matter more count more toward the final score.
     231. Pick which profile fields to use for matching in the admin panel
     242. Assign a weight to each field so important fields count more
     253. Choose a comparison mode for each field (exact, overlap, range, or partial)
     264. Members browse the site and see compatibility percentages on every profile and in the members directory
    2627
    27 ⚡ **SQL first performance** All matching runs through optimized database queries, not slow PHP loops. One query handles a full directory page with hundreds of members.
     28= ⚙️ Matching Engine =
    2829
    29 🔄 **4 comparison modes** Exact match for dropdowns, overlap (Jaccard) for checkboxes, range for numbers, and partial for text similarity.
     30* **Weighted scoring** Assign a percentage weight to each xProfile field. Fields that matter more contribute more toward the final compatibility score.
     31* **4 comparison modes** Exact match for dropdowns and radio buttons, overlap (Jaccard similarity) for checkboxes and multi select fields, range for numeric values, and partial for free text similarity.
     32* **Hard exclusions** Mark any field as must match. If two members do not match on a hard exclude field, their compatibility drops to 0% instantly. Useful for language, location, or any critical criteria.
     33* **Deal breakers** A softer penalty that reduces the score when an important field does not match, without zeroing it completely.
     34* **Confidence indicator** Shows what percentage of weighted fields both members actually filled out. A 92% match with low confidence means only a few fields were compared. Helps members understand how reliable a score is.
    3035
    31 🛡️ **Hard exclusions** Mark fields as must match. If a hard exclude field does not match, the pair gets 0% instantly.
     36= ⚡ Performance =
    3237
    33 ⚠️ **Deal breakers** Soft penalty that reduces the score when an important field does not match, without zeroing it.
     38* **SQL first architecture** All scoring runs through optimized database queries, not slow PHP loops. A single query handles an entire directory page with hundreds of members.
     39* **Database caching** A dedicated cache table stores computed scores with configurable expiration. Scores are automatically cleared when a member updates their profile.
     40* **Lazy loading directory** Match percentages load on demand as members scroll into view using IntersectionObserver. The page loads instantly without waiting for match calculations.
     41* **Batch recalculation** WP Cron powered background processing recalculates scores in bulk for large communities.
    3442
    35 📊 **Confidence indicator** Shows how many configured fields both users actually answered. A 90% match with low confidence means few fields were comparable.
     43= 🎨 Display =
    3644
    37 🔵 **Circle and badge display** SVG circle progress and pill badge included. Clean, mobile responsive, no bloated CSS.
     45* **Circle and badge styles** Choose between an SVG circle progress indicator or a compact pill badge. Both are mobile responsive and lightweight.
     46* **Color thresholds** Configure which colors represent high, medium, and low compatibility so members can read scores at a glance.
     47* **Shortcode support** Use `[matchme]` to display a match score anywhere on your site. The legacy `[mp_match_percentage]` shortcode still works for backward compatibility.
    3848
    39 🔍 **Lazy loading directory** Match percentages load via IntersectionObserver as members scroll into view. No blocking on page load.
     49= 🔌 Developer Friendly =
    4050
    41 💾 **Database caching** Dedicated cache table with configurable TTL. Auto invalidation when profiles change. Batch recalculation via WP Cron.
     51* **REST API** `GET /matchme/v1/match/{user_id}` returns percentage, confidence, and optional field breakdown in JSON.
     52* **13 hooks** Actions and filters let themes and addons extend the matching engine, display output, admin settings, and API responses without modifying plugin files.
     53* **Field completion nudges** Automatic prompts encourage members to fill in missing profile fields that would improve their match quality.
    4254
    43 🎨 **Modern admin interface** Settings page with Plus Jakarta Sans, AJAX save with toast notifications, and inline confirmations.
     55= 🛡️ Secure and Private =
    4456
    45 🧩 **Shortcode support** `[matchme]` displays a match score anywhere. `[mp_match_percentage]` still works for backward compatibility.
     57Nonce verification, capability checks, and input sanitization on every request. Match data is only visible to logged in members. No anonymous access, no external API calls, no tracking, and no third party dependencies. Everything runs entirely on your server.
    4658
    47 🔌 **REST API** `GET /matchme/v1/match/{user_id}` returns percentage, confidence, and optional breakdown.
     59= 💎 Pro (Coming Soon) =
    4860
    49 📝 **Field completion nudges** Prompts users to fill missing profile fields that improve match quality.
     61* **Per field breakdown** Detailed tooltip showing exactly what matched, what did not, and which fields were missing for each member pair
     62* **Advanced directory filters** Filter the members directory by minimum match percentage and specific field values
     63* **Unlimited top matches** Show an unlimited number of top matches on each member profile
     64* **Bar and heart display styles** Additional display options with a color customizer and animations
     65* **Advanced export and reports** CSV and JSON export with date filters, scheduled email reports, and delivery options
    5066
    51 🔒 **Secure by default** Nonce verification, capability checks, sanitized inputs. No anonymous access to match data.
     67= 🏢 Business (Coming Soon) =
    5268
    53 🧱 **Extension ready** 13 hooks (actions and filters) let addons extend the engine, display, admin, and API without touching core files.
    54 
    55 = 💎 Upcoming Pro =
    56 
    57 Premium features coming soon to supercharge your matchmaking community:
    58 
    59 🧮 **Per field breakdown** Detailed tooltip showing what matched, what did not, and which fields were missing for each member pair.
    60 
    61 🔎 **Advanced directory filters** Filter the members directory by minimum match percentage and specific field values.
    62 
    63 🏆 **Unlimited top matches** Display an unlimited number of top matches on member profiles.
    64 
    65 🎨 **Bar and heart display styles** Additional display options with color customizer and animations beyond the free circle and badge styles.
    66 
    67 📤 **Advanced export and reports** CSV and JSON export with date filters, scheduled reports, and email delivery.
    68 
    69 = 🏢 Upcoming Business =
    70 
    71 Enterprise grade features for large communities and professional matchmaking platforms:
    72 
    73 🔔 **Match based notifications** Email alerts when a high compatibility match is found.
    74 
    75 💬 **Message unlock rules** Set matching thresholds, mutual match requirements, and cooldown periods before members can message each other.
    76 
    77 👥 **Role to role match rules** Member type and role matrix for controlling which roles can match with each other.
    78 
    79 📈 **Match analytics** Distribution charts, trends, and per user match history.
    80 
    81 🤖 **Automation and webhooks** Trigger actions on match thresholds with CRM and email integration support.
    82 
    83 🧪 **A/B scoring profiles** Test different scoring models before publishing them to all members.
    84 
    85 📍 **Geo and distance matching** Radius based matching with location weighting.
    86 
    87 📋 **Saved segments** Smart lists such as members with 80% or higher match scores who were active recently.
    88 
    89 ⏱️ **Scheduled recalculation** Background recalculation jobs with queue controls.
    90 
    91 = 👆 Swipe Addon =
    92 
    93 A separate Swipe addon is also planned, adding a card based discovery UI for browsing matches.
     69* **Match based notifications** Automatic email alerts when a high compatibility match is discovered
     70* **Message unlock rules** Require a minimum match percentage or mutual match before members can message each other
     71* **Role to role match rules** Control which member types and roles can match using a visual matrix
     72* **Match analytics** Distribution charts, trend graphs, and per member match history
     73* **Automation and webhooks** Trigger external actions when match thresholds are reached, with CRM and email platform integration
     74* **Geo and distance matching** Radius based matching with configurable location weighting
     75* **Saved segments** Create smart member lists such as "80% or higher compatibility and active in the last 7 days"
    9476
    9577== Installation ==
    … …  
    98802. Search for **Match Me for BuddyPress & BuddyBoss**
    99813. Click **Install Now**, then **Activate**
    100 4. Go to **Match Me** in the admin menu
     824. Go to **Match Me** in the admin menu to configure your fields
    10183
    10284Or upload the `match-me-for-buddypress` folder to your plugins directory and activate.
    10385
    104 **Requires** BuddyPress or BuddyBoss Platform to be installed and active.
     86Requires BuddyPress or BuddyBoss Platform to be installed and active.
    10587
    10688== Frequently Asked Questions ==
    … …  
    11092BuddyPress and BuddyBoss Platform. The plugin auto detects which one is active.
    11193
     94= What kind of sites can use this? =
     95
     96Any community where connecting compatible members matters. Dating and relationship sites, professional networking platforms, roommate and housing finders, mentor and mentee matching, study group formation, co founder matching, and more.
     97
    11298= How are matches calculated? =
    11399
    114 Each xProfile field gets a weight and comparison mode. The engine runs a single SQL query to fetch both users' field values, scores each field, and produces a weighted percentage. Exact matches are scored directly in SQL for maximum performance.
     100Each xProfile field gets a weight and comparison mode. The engine fetches both members' field values in a single SQL query, scores each field according to its mode, and combines them into a weighted percentage.
    115101
    116102= What are comparison modes? =
    … …  
    118104**Exact** scores 100% when values match, 0% otherwise. Best for dropdowns and radio buttons.
    119105
    120 **Overlap** uses Jaccard similarity on multi value fields like checkboxes. More shared selections means a higher score.
     106**Overlap** uses Jaccard similarity for multi value fields like checkboxes. More shared selections means a higher score.
    121107
    122 **Range** scores by how close two numbers are within a configurable tolerance. Best for numeric textbox fields.
     108**Range** scores by how close two numbers are within a configurable tolerance. Best for numeric fields like age or budget.
    123109
    124 **Partial** scores by text similarity. Best for free text fields like job titles.
     110**Partial** scores by text similarity. Best for free text fields like job titles or interests.
    125111
    126112= What is a hard exclusion? =
    127113
    128 A must match field. If a hard exclude field does not match between two users, the entire match drops to 0% instantly. Use for critical fields like language or location.
     114A must match field. If two members do not match on a hard exclude field, their entire compatibility drops to 0%. Use for critical criteria like language, location, or gender preference.
    129115
    130116= What is the confidence score? =
    131117
    132 It shows what percentage of configured field weights both users actually have data for. High confidence means most fields were comparable. Low confidence means many fields were empty.
     118It shows what percentage of configured field weights both members actually have data for. High confidence means most fields were compared. Low confidence means many fields were left empty by one or both members.
    133119
    134 = Does matching work with hundreds of members? =
     120= Does it scale to large communities? =
    135121
    136 Yes. The engine uses bulk SQL queries and a dedicated cache table. A directory page with 100 members loads match data in 1 to 2 queries. Uncached results are calculated lazily via AJAX as members scroll into view.
     122Yes. The engine uses optimized SQL queries and a dedicated cache table. A directory page with 100 members loads match data in 1 to 2 queries. Uncached results calculate lazily via AJAX as members scroll into view.
    137123
    138124= Is match data visible to everyone? =
    139125
    140 Match scores are visible to all logged in members. Anonymous visitors see nothing. Admins can toggle between showing percentage only or a full per field breakdown.
     126Match scores are visible to all logged in members. Anonymous visitors see nothing.
    141127
    142128= Can I customize the display? =
    143129
    144 The free plugin includes circle and badge styles with configurable colors for high, medium, and low thresholds. Pro will add bar and heart styles with advanced animations.
     130Yes. Choose between circle progress and badge styles, and configure separate colors for high, medium, and low match thresholds in the admin.
    145131
    146132= Is the old shortcode still supported? =
    … …  
    148134Yes. `[mp_match_percentage]` still works and renders the same output as the new `[matchme]` shortcode.
    149135
    150 = Can I request customisation? =
     136= Can I request custom development? =
    151137
    152 Yes! The base plugin is free but we offer custom feature development. If you need a tailored matching algorithm, custom display styles, third party integrations, or any other modification, send your requirements to hello@meshpros.com for a quote.
     138Yes. We offer custom feature development for tailored matching algorithms, display styles, and third party integrations. Contact hello@meshpros.com for a quote.
    153139
    154 = Does it phone home? =
     140= Does it phone home or require external services? =
    155141
    156 No. Everything runs on your server. No external requests, no tracking, no third party dependencies.
     142No. Everything runs on your server. No external requests, no tracking, no analytics, and no third party dependencies.
    157143
    158144== Screenshots ==
    … …  
    169155= 2.0.0 =
    170156
    171 🎉 Complete rewrite from the ground up
     157Complete rewrite from the ground up.
    172158
    173 ⚡ SQL first matching engine replacing PHP loop approach
    174 🔄 4 comparison modes: exact, overlap, range, partial
    175 🛡️ Hard exclusion and deal breaker support
    176 📊 Confidence score alongside match percentage
    177 💾 Dedicated cache table with auto invalidation
    178 🔍 Lazy loading directory via IntersectionObserver
    179 🎨 Modern admin with 4 tabs and AJAX save
    180 📝 Field completion nudges
    181 🔌 REST API endpoint
    182 🧩 13 extension hooks for addons
    183 🔒 Full security: nonces, capability checks, no nopriv endpoints
    184 🔵 SVG circle and badge display
    185 🧱 Backward compatible `[mp_match_percentage]` shortcode
    186 🧹 Clean uninstall with table removal
     159* SQL first matching engine replacing the PHP loop approach
     160* 4 comparison modes: exact, overlap, range, partial
     161* Hard exclusion and deal breaker support
     162* Confidence score alongside match percentage
     163* Dedicated cache table with auto invalidation
     164* Lazy loading directory via IntersectionObserver
     165* Modern admin with tabbed settings and AJAX save
     166* Field completion nudges for members
     167* REST API endpoint for developers
     168* 13 extension hooks for themes and addons
     169* Full security: nonces, capability checks, sanitized inputs
     170* SVG circle and badge display styles
     171* Backward compatible shortcode support
     172* Clean uninstall with complete table removal
    187173
    188174= 1.3 =
Note: See TracChangeset for help on using the changeset viewer.