Plugin Directory

Changeset 3395607


Ignore:
Timestamp:
11/14/2025 09:07:55 AM (3 months ago)
Author:
tryfalan
Message:

Update readme file

Location:
the-get-hired-button
Files:
4 added
1 edited

Legend:

Unmodified
Added
Removed
  • the-get-hired-button/trunk/readme.txt

    r3395129 r3395607  
    1313== Description ==
    1414
    15 The Get Hired Button plugin seamlessly integrates TryMe's powerful recruitment widget into your WordPress website. This lightweight plugin helps you convert more job seekers into applicants by providing a streamlined application experience directly on your career pages.
     15The Get Hired Button — Simple, Automatic, and Ready to Go
     16Once you install the plugin, the Get Hired Button usually appears on your site automatically. 🎉
     17No complicated setup. No coding. It just works.
     18If the button doesn’t show right away, no stress — it just means we need your widget token.
    1619
    17 = Key Features =
     20= Add Your Widget Token (only if needed) =
    1821
    19 * **Easy Setup** - Install and configure in minutes with a simple admin interface
    20 * **Flexible Authentication** - Supports three authentication modes:
    21   * Token Mode (recommended) - Secure connection with your TryMe account
    22   * Host Matching - Automatic domain-based authentication
    23   * Guest Mode - Immediate functionality for new users
    24 * **Lightweight** - Minimal impact on page load times with async script loading
    25 * **No Coding Required** - Simple configuration through WordPress admin
    26 * **HTTPS Secure** - All connections use secure HTTPS protocol
    27 * **Multisite Compatible** - Works with WordPress multisite installations
     22Most users won’t ever need to do this, but if auto-connect didn’t pick up your site:
     23Log in to [TRYclub.com](https://www.tryclub.com)
     24Open Get Hired Button → Settings
     25Copy your widget token
     26Paste it into the plugin settings and click Save
     27💡 Tip: Even if you skip the token, the plugin still runs safely in automatic mode so you can try it right away.
    2828
    29 = How It Works =
     29= What the Plugin Does =
    3030
    31 The Get Hired Button adds TryMe's recruitment widget to your website, enabling candidates to quickly apply for positions. The widget appears on your site and connects to your TryMe account to manage applications.
     31The Get Hired Button brings TRY’s hiring widget to your WordPress site.
     32Visitors can chat, request proposals, book appointments, or hire you — directly from your own website.
     33No code required. No theme headaches. No performance issues.
    3234
    33 **Authentication Cascade:**
    34 1. If you provide a widget token, the button uses secure token authentication
    35 2. If no token is provided, it attempts to match your domain with your TryMe account
    36 3. If no match is found, it works in guest mode so you can test immediately
     35= How It Connects (Behind the Scenes) =
     36Everything is designed to “just work”:
     371. Token Mode (best) — If you paste in a token, we connect instantly and securely.
     382. Auto-Detect Mode — No token? We automatically try to match your site’s domain to your TRY account.
     393. Guest Mode — Not connected yet? The button still works so you can test it immediately.
    3740
    38 = Perfect For =
     41= Why People Love It =
    3942
    40 * Companies with career pages on WordPress
    41 * Recruitment agencies managing multiple client sites
    42 * HR departments looking to streamline their application process
    43 * Organizations wanting to improve candidate experience
     43* Works automatically in most cases
     44* Friendly, no-stress setup
     45* Loads asynchronously (keeps your site fast)
     46* Secure and fully HTTPS-compatible
     47* Works with WordPress multisite
     48* Great for freelancers, creators, consultants, agencies, and small businesses
    4449
    4550= Requirements =
     
    4752* WordPress 5.8 or higher
    4853* PHP 7.4 or higher
    49 * HTTPS enabled (recommended for security)
    50 * A TryMe account (free to create at [tryme.co](https://www.tryme.co))
     54* A TRY account (free at [TRYME.co](https://www.tryme.co))
     55* HTTPS recommended for best reliability
    5156
    52 = Privacy & Data =
     57= Privacy =
    5358
    54 This plugin loads an external JavaScript file from tryme.co to display the recruitment widget. When candidates interact with the button, their data is processed according to TryMe's privacy policy. No personal data is collected by the plugin itself.
     59The plugin loads a small external script from TRYME.co to display your widget.
     60All visitor interactions follow TRY’s privacy policy.
     61The plugin itself collects no personal data.
     62
     63= Troubleshooting =
     64
     65* Confirm your site URL matches the one in your TRY account
     66* Try clearing your cache or opening your site in incognito mode
     67* HTTPS improves reliability
     68* Need help? We’re here → [tryclub.com/contact](https://tryclub.com/contact)
     69
     70= For Developers (optional) =
     71
     72* Uses standard WordPress hooks (`wp_body_open`, `admin_menu`, `admin_init`)
     73* Async loading for performance
     74* Clean uninstall removes all plugin options
     75* Constants include: `GHB_VERSION`, `GHB_PLUGIN_FILE`, `GHB_PLUGIN_DIR`
     76
     77Thanks for using the Get Hired Button — helping you turn every visitor into an opportunity.
    5578
    5679== Installation ==
     
    5881= Automatic Installation =
    5982
    60 1. Log in to your WordPress admin panel
    61 2. Navigate to Plugins > Add New
    62 3. Search for "Get Hired Button"
    63 4. Click "Install Now" and then "Activate"
    64 5. Go to Settings > Get Hired Button to configure
     831. Log in to your WordPress admin panel.
     842. Navigate to **Plugins** → **Add New**.
     853. Search for **“Get Hired Button”**.
     864. Click **Install Now**, then **Activate**.
     875. Go to **Settings** → **Get Hired Button** to configure the plugin.
    6588
    6689= Manual Installation =
    6790
    68 1. Download the plugin zip file
    69 2. Extract the zip file
    70 3. Upload the `get-hired-button` folder to `/wp-content/plugins/`
    71 4. Activate the plugin through the 'Plugins' menu in WordPress
    72 5. Go to Settings > Get Hired Button to configure
     911. Download the plugin ZIP file.
     922. Extract the ZIP file.
     933. Upload the **get-hired-button** folder to `/wp-content/plugins/` directory
     944. Activate the plugin through the **Plugins** menu in WordPress
     955. Go to **Settings** > **Get Hired Button** to configure the plugin.
    7396
    7497= Configuration =
    7598
    76 **Option 1: Token Mode (Recommended)**
    77 1. Log in to your TryMe dashboard at [tryme.co](https://www.tryme.co)
    78 2. Navigate to your Get Hired button widget settings
    79 3. Select your widget and click "View" to see your token
    80 4. Copy the widget token (UUID format)
    81 5. In WordPress, go to Settings > Get Hired Button
    82 6. Paste the token and click "Save Settings"
     99**Most of the Time, No Setup Is Needed**
     100After activating the plugin, the Get Hired Button will usually appear automatically using your site’s domain.
     101If your domain matches the one in your TRY account, it connects immediately.
     102If not, the button still works in Guest Mode so you can try it right away.
    83103
    84 **Option 2: Host Matching or Guest Mode**
    85 1. Simply activate the plugin
    86 2. The button will automatically appear on your site
    87 3. It will attempt to match your domain or work in guest mode
    88 4. For full functionality, register your domain at TryMe
     104**Automatic Mode (Host Matching + Guest Mode)**
     105If you prefer not to add a token yet:
     106* Activate the plugin.
     107* The button will attempt to auto-connect using your domain.
     108* If no match is found, it will run in Guest Mode so you can preview the button.
     109* For full functionality, register your domain inside TRY.
     110
     111**If the Button Does Not Appear: Add Your Token (Recommended)**
     1121. Log in to your TRY dashboard at [TRYclub.com](https://www.tryclub.com).
     1132. Navigate to **Get Hired Button** -> **Settings**.
     1143. Select your widget and click View to reveal your token.
     1154. Copy the token (a long UUID).
     1165. In WordPress, go to **Settings** → **Get Hired Button**.
     1176. Paste your token and click **Save Settings**.
     118Your site is now fully connected.
     119
     120**Need help? We’re here to assist:** [https://www.tryclub.com/contact](https://www.tryclub.com/contact)
    89121
    90122== Frequently Asked Questions ==
     
    150182== Changelog ==
    151183
    152 = 1.0.0 - 2024-10-16 =
     184= 1.0 - 2024-11-13 =
    153185* Initial release
    154186* Token-based authentication
     
    161193* Uninstall cleanup
    162194
    163 == Upgrade Notice ==
    164 
    165 = 1.0.0 =
    166 Initial release of The Get Hired Button plugin.
    167 
    168 == Support ==
    169 
    170 For support, please visit:
    171 * Plugin support forum on WordPress.org
    172 * TryMe support at [tryme.co/contact](https://www.tryme.co/contact)
    173 * Instructions at [tryme.co/get-hired-button/wp-plugin/instructions](https://www.tryme.co/get-hired-button/wp-plugin/instructions)
    174 
    175 == Developer Notes ==
    176 
    177 = Hooks & Filters =
    178 
    179 The plugin uses standard WordPress hooks:
    180 * `wp_body_open` - Outputs the widget script
    181 * `admin_menu` - Adds settings page
    182 * `admin_init` - Registers settings
    183 
    184 = Constants =
    185 
    186 * `GHB_VERSION` - Plugin version number
    187 * `GHB_PLUGIN_FILE` - Main plugin file path
    188 * `GHB_PLUGIN_DIR` - Plugin directory path
    189 
    190 = Uninstall =
    191 
    192 The plugin includes a proper uninstall script that removes all options from the database when the plugin is deleted.
    193 
    194 == Credits ==
    195 
    196 Developed by Falan Austin for TryMe
     195= 1.1 - 2024-11-14 =
     196* Update README with improved Instructions and Description
Note: See TracChangeset for help on using the changeset viewer.