Skip to content

Commit

Permalink
added getting started guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Rob Locke committed Jan 28, 2024
1 parent 05220a6 commit 067d804
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 27 deletions.
40 changes: 20 additions & 20 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Super Search #
# SuperSearch #

Contributors: hiorbit
Tags: super search, wordpress search, woocommerce search, product search, search, fast search, post search, page search, filterable search, mobile search, responsive search, divi search
Tags: supersearch, wordpress search, woocommerce search, product search, search, fast search, post search, page search, filterable search, mobile search, responsive search, divi search
Requires at least: 6.4.2
Tested up to: 6.4.2
Requires PHP: 8.0
Expand All @@ -14,39 +14,39 @@ Improved WordPress and WooCommerce search with lightning-fast results. Search pr
## Description ##
#### Enhance your search experience ####

Super Search revolutionizes the way users interact with your website by providing a powerful and lightning-fast search solution. Say goodbye to the limitations of the default WordPress or WooCommerce search – Super Search is your drop-in solution for an enhanced user experience.
SuperSearch revolutionizes the way users interact with your website by providing a powerful and lightning-fast search solution. Say goodbye to the limitations of the default WordPress or WooCommerce search – SuperSearch is your drop-in solution for an enhanced user experience.


#### Features ####

* **Search and filter by Post, Page & Product** - The default WordPress search mixes all our content together, making it hard to find what you need. Super Search allows users to seamlessly filter results by type for post, page, and product.
* **Search and filter by Post, Page & Product** - The default WordPress search mixes all our content together, making it hard to find what you need. SuperSearch allows users to seamlessly filter results by type for post, page, and product.
* **Simple Integration** - Add anywhere using shortcode. No coding knowledge is required!
* **Fast Search** - Off-site processing prevents any slowdown on your page, even on large sites/catalogues.
* **Organised Results** - Filter search results by type and category directly in the search modal.
* **Responsive design** - Designed to adapt seamlessly to all screen sizes.
* **Display relevent categories** - Super Search shows a list of categories relevant to your search results.
* **No site slowdown, no matter how large** - Use Super Search without the worry of site slowdown, even on the most expansive websites or large product catalogues.
* **Display relevent categories** - SuperSearch shows a list of categories relevant to your search results.
* **No site slowdown, no matter how large** - Use SuperSearch without the worry of site slowdown, even on the most expansive websites or large product catalogues.

#### Why You Need An Improved WordPress Search ####

The default WordPress search often falls short of user expectations. By combining all search results onto one page it can be difficult to find what you need, whether it is products or blog posts.

Super Search addresses these limitations by allowing users to tailor their search based on content type, streamlining the search process without and eliminating the need to navigate away from the page.
SuperSearch addresses these limitations by allowing users to tailor their search based on content type, streamlining the search process without and eliminating the need to navigate away from the page.

You can effortlessly enhance your website’s search functionality by adding Super Search anywhere on your site using a simple shortcode. Experience the power of Super Search without the hassle – install it swiftly and effortlessly, and watch your search capabilities transform instantly!
You can effortlessly enhance your website’s search functionality by adding SuperSearch anywhere on your site using a simple shortcode. Experience the power of SuperSearch without the hassle – install it swiftly and effortlessly, and watch your search capabilities transform instantly!


#### See search results fast ####

**Here’s how we make it happen:**
When you install the plugin, you syncronise your site data to our Super Search platform. We process this data to what we call a search index, which is data optimized for searching. You can manually update the search index when you choose from the plugin, or once a day the plugin will automatically send updates to the search index when a page, post or product created or updated.
When you install the plugin, you syncronise your site data to our SuperSearch platform. We process this data to what we call a search index, which is data optimized for searching. You can manually update the search index when you choose from the plugin, or once a day the plugin will automatically send updates to the search index when a page, post or product created or updated.

Our search index is a streamlined extract of your site data converted into structure that provides fast data lookup, significantly enhancing the speed of search results. We further process this data by implementing additional index optimization to improve the search results that handle typos and relavance of the results. The outcome? Lightning-fast context and relavant search results that transform the user experience, making finding information on your site quick, efficient, and incredibly responsive.

The WordPress plugin is released under the MIT license, which does NOT extend to any associated Hi-Orbit services.

### Installation ###
* Log into your WordPress admin, navigate to Plugins > Add New, then search for Super Search.
* Log into your WordPress admin, navigate to Plugins > Add New, then search for SuperSearch.
* Install and activate the plugin
* For full setup instructions visit our [Knowledge Base] (https://hi-orbit.com/knowledge-base/getting-started/)

Expand All @@ -58,23 +58,23 @@ The position of the search window is based on an offset from the top of the scre

When setting your Search Window Position make sure to check your site when you are not logged in to make sure that the search bar displays correctly.

**How do I create a Super Search account?**
**How do I create a SuperSearch account?**

You can create an account on Super Search for free. [Create an account here](https://supersearch.hi-orbit.com/register).
You can create an account on SuperSearch for free. [Create an account here](https://supersearch.hi-orbit.com/register).

**How do I add my API details?**

Follow our guide on [how to add API details](https://hi-orbit.com/knowledge-base/getting-started/add-your-api-details/).

* Log in to your Super Search account
* On the Super Search dashboard, select ‘sites’ in the sidebar and create a new site.
* Log in to your SuperSearch account
* On the SuperSearch dashboard, select ‘sites’ in the sidebar and create a new site.
* Copy your public and private keys.
* Go to your WordPress website admin, select Settings > Super Search and add the keys.
* Go to your WordPress website admin, select Settings > SuperSearch and add the keys.

**How do I sync my content?**

Log in to your WordPress dashboard and navigate to ‘Settings’ and then ‘Super Search’ in the side menu.
Select sync in the top tabs on the Super Search dashboard and click each of the 'Sync Products To Search Index' buttons.
Log in to your WordPress dashboard and navigate to ‘Settings’ and then ‘SuperSearch’ in the side menu.
Select sync in the top tabs on the SuperSearch dashboard and click each of the 'Sync Products To Search Index' buttons.
Once all the sync progress bars have reached 100% and our servers have processed your data your search is ready!

**How do replace my search bar?**
Expand All @@ -83,11 +83,11 @@ To add search to your website use the shortcode [supersearch]

**How do I adjust the offset of my search bar?**

If your search bar is showing too high up on the page or too low down you can set an offset by navigating to ‘Settings’ in the Super Search dashboard. The offset is measured in pixels.
If your search bar is showing too high up on the page or too low down you can set an offset by navigating to ‘Settings’ in the SuperSearch dashboard. The offset is measured in pixels.

**Can I change the Super Search button colours?**
**Can I change the SuperSearch button colours?**

To change the colours of your Super Search buttons log in to your Super Search console.
To change the colours of your SuperSearch buttons log in to your SuperSearch console.
Head to ‘search settings’
Select Edit
Enter your Hex code and save
Expand Down
15 changes: 8 additions & 7 deletions supersearch.php
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<?php

/**
* Plugin Name: Super Search
* Description: Super Search provides a hyperfast search solution for your WordPress site.
* Plugin Name: SuperSearch
* Description: SuperSearch provides a hyperfast search solution for your WordPress site.
* Version: 1.0.6
* Author: https://www.hi-orbit.com
*/
Expand All @@ -16,8 +16,8 @@
function supersearch_settings_menu()
{
add_options_page(
'Super Search Settings', // Page title
'Super Search', // Menu title
'SuperSearch Settings', // Page title
'SuperSearch', // Menu title
'manage_options', // Capability
'supersearch-settings', // Menu slug
'supersearch_settings_page' // Callback function
Expand All @@ -31,8 +31,8 @@ function supersearch_add_tabs() {
$active_tab = isset($_GET['tab']) ? $_GET['tab'] : 'usage';

?>
<h1>Super Search Settings</h1>
<p>Super Search provides a hyperfast search solution for your WordPress site.</p>
<h1>SuperSearch Settings</h1>
<p>SuperSearch provides a hyperfast search solution for your WordPress site.</p>
<h2 class="nav-tab-wrapper">
<a href="?page=supersearch-settings&tab=usage" class="nav-tab <?php echo $active_tab == 'usage' ? 'nav-tab-active' : ''; ?>">Account Usage</a>
<a href="?page=supersearch-settings&tab=settings" class="nav-tab <?php echo $active_tab == 'settings' ? 'nav-tab-active' : ''; ?>">Settings</a>
Expand Down Expand Up @@ -74,6 +74,7 @@ function supersearch_settings_page()
Search index: <div style="width:300px;border: 1px solid grey;"><div id="searchitem-progress-bar" style="width: 0%; height: 20px; background-color: green;"></div></div>
<?php echo $stats->data->search_item_count; ?> of <?php echo $stats->data->search_item_limit; ?>
<p><strong>Manage your plan <a href="https://supersearch.hi-orbit.com/admin/plans" target="_blank">here</a></strong></p>
<p>Watch our getting started guide <a href="https://hi-orbit.com/knowledge-base/getting-started/how-to-install-and-configure/" target="_blank">here</a></strong></p>
<?php
} else {
echo '<p>Unable to retrieve usage stats.</p>';
Expand All @@ -90,7 +91,7 @@ function supersearch_settings_page()
?>
</form>
<?php } else if ($active_tab == 'sync') { ?>
<h2>Sync Products, Posts, and Pages to Super Search search index</h2>
<h2>Sync Products, Posts, and Pages to SuperSearch search index</h2>
<p>We track when products, posts and pages are created and updated and once a day we automatically sync changes to our search index. If you want to sync everything immediately, click the buttons below.</p>
<p><strong>The sync process may take some time, please do not close this window until the sync has completed.</strong></p>
<button class="button button-secondary" id="start-products-process">Sync Products To Search Index</button>
Expand Down

0 comments on commit 067d804

Please sign in to comment.