Update README

README.md

@@ -5,7 +5,7 @@
 > [!IMPORTANT]
 > This project is not affiliated with Bridge Interactive or Zillow. Please do not contact them for support related to issues with this plugin.
 
-A WordPress plugin that displays a comprehensive, searchable directory of office locations using the Bridge Interactive API.
+A WordPress plugin that displays a comprehensive, searchable directory of office locations using the [Bridge Interactive API](https://bridgedataoutput.com/docs/explorer/mls-data#listOffices).
 
 ## Table of Contents
 
@@ -22,7 +22,7 @@ A WordPress plugin that displays a comprehensive, searchable directory of office
 - **Responsive Office Directory**: Displays offices in a grid of interactive cards, each showing essential information such as name, address, phone, email, and website.
 - **Advanced Search**: Users can search for offices by name, address, phone number, or email with instant feedback thanks to client-side filtering and debounce optimization.
 - **Infinite Scroll**: Offices are loaded automatically as users scroll, enhancing the user experience without traditional pagination.
-- **Automated Data Sync**: Full and incremental synchronization with the Bridge Interactive API to keep office data current, including handling of inactive records.
+- **Automated Data Sync**: Full and incremental synchronization with the [Bridge Interactive API](https://bridgedataoutput.com/docs/explorer/mls-data#listOffices) to keep office data current, including handling of inactive records.
 - **Custom Database Storage**: Utilizes a custom WordPress database table for efficient storage and retrieval, optimized for large datasets.
 - **User-Friendly Admin Interface**: Intuitive settings page for configuring API access, synchronization intervals, and managing data directly from the WordPress admin dashboard.
 
@@ -77,6 +77,7 @@ If you chose Option B and are setting up the plugin for development purposes, fr
 ### API Access
 
 - **Access Token**: Required. Obtain this from your Bridge Data Output API account.
+  - Refer to the [Bridge API Explorer and Documentation](https://bridgedataoutput.com/docs/explorer/mls-data#listOffices) for more information on obtaining an access token and available datasets.
 - **Dataset Name**: Required. The dataset you want to query (e.g., `itso`).
 
 ### Sync Settings

bridge-directory/README.txt

@@ -1,10 +1,101 @@
 === Bridge Directory ===
 Contributors: justinhrahb
-Tags: real estate, bridge, brokerage, api
-Requires at least: 5.0
+Tags: real estate, bridge, api, directory, listings
+Requires at least: 6.0
 Tested up to: 6.6.2
-Stable tag: 0.3.2
+Requires PHP: 8.0
+Stable tag: 0.3.3
 License: GPLv2
 License URI: http://www.gnu.org/licenses/gpl-2.0.html
 
-Displays a searchable directory of offices using the Bridge Interactive API.
+Displays a comprehensive, searchable directory of office locations using the Bridge Interactive API.
+
+== Description ==
+
+**Bridge Directory** is a WordPress plugin that displays a comprehensive, searchable directory of office locations using the [Bridge Interactive API](https://bridgedataoutput.com/docs/explorer/mls-data#listOffices).
+
+### Features
+
+– **Responsive Office Directory**: Displays offices in a grid of interactive cards, showing essential information such as name, address, phone, email, and website.
+– **Advanced Search**: Users can search for offices by name, address, phone number, or email with instant feedback thanks to client-side filtering and debounce optimization.
+– **Infinite Scroll**: Offices are loaded automatically as users scroll, enhancing the user experience without traditional pagination.
+– **Automated Data Sync**: Full and incremental synchronization with the [Bridge Interactive API](https://bridgedataoutput.com/docs/explorer/mls-data#listOffices) to keep office data current, including handling of inactive records.
+– **Custom Database Storage**: Utilizes a custom WordPress database table for efficient storage and retrieval, optimized for large datasets.
+– **User-Friendly Admin Interface**: Intuitive settings page for configuring API access, synchronization intervals, and managing data directly from the WordPress admin dashboard.
+
+### Benefits
+
+**For Website Visitors**
+
+– **Enhanced User Experience**: Easily find and contact the nearest office with an intuitive and responsive interface.
+– **Quick Access to Information**: Advanced search functionality reduces the time needed to locate specific offices.
+
+**For Administrators**
+
+– **Operational Efficiency**: Automates the updating of office information, reducing manual workload and minimizing errors.
+– **Accurate Data**: Ensures the directory reflects the most current office statuses and details.
+– **Scalable Solution**: Designed to handle growth as more offices are added without significant redevelopment.
+
+== Installation ==
+
+1. **Upload the Plugin**:
+   – Upload the `bridge-directory` folder to the `/wp-content/plugins/` directory, or install the plugin through the WordPress plugins screen directly.
+2. **Activate the Plugin**:
+   – Activate the plugin through the 'Plugins' screen in WordPress.
+3. **Configure Plugin Settings**:
+   – Navigate to `Settings` -> `Bridge Directory` in the WordPress admin dashboard.
+   – **Access Token**: Enter your Bridge Data Output API access token.
+   – **Dataset Name**: Specify the dataset name to query (e.g., `test`).
+   – **Sync Interval**: Set how often (in hours) to perform incremental syncs. Default is every 24 hours.
+   – **Advanced Query Filter**: (Optional) Add additional query parameters for API requests. Do not include `OfficeStatus` or `ModificationTimestamp.gt` in this field.
+4. **Data Synchronization**:
+   – Click the **Full Sync** button to initiate the initial data synchronization.
+5. **Add Office Directory to Pages or Posts**:
+   – In the WordPress block editor, add the **Office List** block to your page or post.
+
+== Frequently Asked Questions ==
+
+= How do I obtain an API access token? =
+
+You can obtain an API access token by signing up on the Bridge Interactive website and requesting API access.
+
+= How often does the plugin synchronize data? =
+
+By default, the plugin synchronizes data every 24 hours. You can change the synchronization interval in the plugin settings.
+
+= Can I customize the displayed fields? =
+
+Currently, the plugin displays predefined fields. Future updates may include customization options.
+
+= How do I add the office directory to my site? =
+
+You can add the **Office List** block in the WordPress block editor.
+
+= What is the Advanced Query Filter? =
+
+The Advanced Query Filter allows you to add custom query parameters to refine the data fetched from the API. Do not include `OfficeStatus` or `ModificationTimestamp.gt` in this field.
+
+== Changelog ==
+
+= 0.3.3 =
+* Updated `readme.txt` to comply with WordPress Plugin Directory requirements.
+* Fixed URL encoding in API requests to handle spaces and dashes in advanced query parameters.
+* Improved settings sanitization to allow valid special characters in advanced queries.
+* Enhanced advanced query handling in the API client for better parameter processing.
+
+= 0.3.2 =
+* Fixed version numbering to match the actual plugin version.
+
+= 0.3.1 =
+* Updated the plugin name to "Bridge Directory" for consistency.
+
+= 0.3.0 =
+* Fixed linting errors for code consistency and maintainability.
+
+== License ==
+
+This plugin is licensed under the GPLv2 or later.
+
+== Additional Notes ==
+
+For support and additional information, please visit the [GitHub repo](https://github.com/RAHB-REALTORS-Association/Bridge-Directory-WP).