Plugin Directory

Changeset 2092431


Ignore:
Timestamp:
05/21/2019 03:34:04 PM (7 years ago)
Author:
gregrickaby
Message:

major revision to readme file

Location:
wp-search-with-algolia
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • wp-search-with-algolia/tags/1.0.0/README.txt

    r2092384 r2092431  
     1
    12=== WP Search with Algolia ===
    23Contributors: WebDevStudios, williamsba1, gregrickaby, tw2113
     
    1213== Description ==
    1314
    14 The plugin provides relevant search results in milliseconds, ensuring that your users can find your best posts at the speed of thought. It also comes with native typo-tolerance and is language-agnostic, so that every WordPress user, no matter where they are, can benefit from it.
     15Improve search on your site. Autocomplete is included, along with full control over look, feel and relevance.
     16
     17Features:
     18- Relevant search results in milliseconds
     19- Native typo-tolerance
     20- Is language-agnostic
     21- Offers hooks and filters for easy customization
     22- Built by developers, for developers
    1523
    1624*The following code is a derivative work of the code from the Algolia Search plugin for WordPress, which is licensed GPLv2.*
    1725
    18 = About pricing =
     26== Requirements ==
    1927
    20 This plugin relies on the [Algolia service](https://www.algolia.com/) which requires you to [create an account here](https://www.algolia.com/users/sign_up). Algolia offers its Search as a Service provider on a incremental payment program, including a free Community Plan which includes 10,000 records & 50,000 operations per month. Beyond that, plans start at $29/month.
    21 
    22 Note that there isn’t a direct correlation between the number of posts in WordPress and the number of records in Algolia. Also note that we only offer support starting from the PRO plan.On average, you can expect to have about 10 times more records than you have posts, though this is not a golden rule and you could end up with more records.
    23 
    24 = Getting started guide =
    25 Once you have installed the plugin, you can follow the step by step guide provided here: https://community.algolia.com/wordpress/configuration.html
    26 
    27 = Relevance =
    28 Algolia enhances your search functionality with a completely customizable search experience which can be seamlessly integrated into your Wordpress theme. It lets you create a find-as-you-type experience or an auto-complete dropdown menu, which provides relevant results from the first keystroke. Our extension also automatically synchronizes data (posts, taxonomies etc.) in real-time, making sure that any updates to your site are available as soon as they are made.
    29 
    30 = Speed =
    31 Algolia returns results in under 35ms on an average – irrespective of whether you have 100s or 1000s of posts. Our state-of-the-art infrastructure and distributed search network ensures that your readers benefit from this, no matter where they are.
    32 
    33 = Accessibility =
    34 WDS Search with Algolia gives you the ability to make all forms of data – blog posts, categories, users etc. – searchable from a single search bar. Algolia also gives you the ability to completely customize your search results based on criteria that makes sense for your business, such as popularity, date, relevance etc.
    35 
    36 = Built by developers for developers =
    37 WDS Search with Algolia is also completely configurable and fully extensible by means of WordPress filters and hooks, letting you build a custom search experience or theme based on Algolia.
    38 
    39 Want to see out how we did it?
    40 
    41 Check it out here: [GitHub Repository](https://github.com/WebDevStudios/wp-search-with-algolia)
    42 
    43 Join the Algolia community and meet thousands of search enthusiasts. https://community.algolia.com/
    44 
    45 == Frequently Asked Questions ==
    46 
    47 = Where can I find Algolia documentation and user guides? =
    48 
    49 - For help setting up and configuring Search by Algolia please refer to our [user guide](https://community.algolia.com/wordpress/installation.html)
    50 - For extending or theming the Autocomplete dropdown, see our [Autocomplete Customization guide](https://community.algolia.com/wordpress/customize-autocomplete.html).
    51 - For extending or theming the Instant Search results page, see our [Search Page Customization guide](https://community.algolia.com/wordpress/customize-search-page.html).
    52 
    53 = Will Algolia work with my theme? =
    54 
    55 Yes; Algolia will work with any theme, but the Instant Search results page may require some styling to make it match nicely.
    56 
    57 = Where can I report bugs or contribute to the project? =
    58 
    59 Bugs can be reported either in our support forum or preferably on the [GitHub repository](https://github.com/WebDevStudios/wp-search-with-algolia/issues).
     28This plugin requires API keys from [Algolia](https://www.algolia.com/). API keys are free for small personal projects and non-commercial use. Learn more about [commercial use pricing](https://www.algolia.com/pricing/).
    6029
    6130== Installation ==
     
    6332= Minimum Requirements =
    6433
     34* Requires WordPress 4.4+
    6535* PHP version 5.6 or greater (PHP 7.0 or greater is recommended)
    6636* MySQL version 5.0 or greater (MySQL 5.6 or greater is recommended)
     37* cURL PHP extension
     38* mbstring PHP extension
     39* OpenSSL greater than 1.0.1
    6740* Some payment gateways require fsockopen support (for IPN access)
    68 * Requires WordPress 4.4+
    6941
    7042Visit the [Search by Algolia server requirements documentation](https://community.algolia.com/wordpress/installation.html) for a detailed list of server requirements.
    7143
    72 = Automatic installation =
     44= Automatic Installation =
     451. In the WP Dashboard, Click on "Plugins" --> "Add New" and search for "WP Search with Algolia"
     462. Activate
     473. *If you have the "Search by Algolia – Instant & Relevant results" plugin installed, please deactivate it first!*
     484. Enter your Algolia API keys
    7349
    74 Automatic installation is the easiest option as WordPress handles the file transfers itself and you don’t need to leave your web browser. To do an automatic install of Search by Algolia, log in to your WordPress dashboard, navigate to the Plugins menu and click Add New.
     50= Manual Installation =
     51Upload the WP Search with Algolia plugin to your site, Activate it, then Enter your Algolia API keys.
    7552
    76 In the search field type “Algolia” and click Search Plugins. Once you’ve found our search plugin you can view details about it such as the point release, rating and description. Most importantly of course, you can install it by simply clicking “Install Now”.
     53== Getting started guide ==
     54Once you have installed the plugin, you can follow the [step by step guide](https://community.algolia.com/wordpress/configuration.html).
    7755
    78 = Manual installation =
     56== Frequently Asked Questions ==
    7957
    80 The manual installation method involves downloading our search plugin and uploading it to your webserver via your favourite FTP application. The WordPress codex contains [instructions on how to do this here](https://codex.wordpress.org/Managing_Plugins#Manual_Plugin_Installation).
     58= Is this plugin a fork? =
     59Yes. The Algolia Team **[no longer supports their original plugin](https://community.algolia.com/wordpress/)**. The engineering team at WebDevStudios has forked the original plugin, and is now maintaining it.
    8160
    82 = Updating =
     61= Should I switch to this plugin? =
     62Yes. Because Algolia no longer supports their plugin, you will no longer receive updates. WebDevStudios uses Algolia on many of it's projects, and is committed to maintaining this plugin for years to come.
    8363
    84 Automatic updates should work like a charm; as always though, ensure you backup your site just in case.
     64= How do I switch? =
     651. Deactivate the "Search by Algolia – Instant & Relevant results" plugin
     662. Follow the installation instructions above
     673. Activate "WP Search with Algolia". Your API keys *should already be there*, if not enter them and save settings
     684. Delete the "Search by Algolia – Instant & Relevant results" plugin
     69
     70= Where can I find Algolia documentation and user guides? =
     71
     72- For help setting up and configuring Search by Algolia please refer to our [user guide](https://community.algolia.com/wordpress/installation.html).
     73- For extending or theming the Autocomplete dropdown, see our [Autocomplete Customization guide](https://community.algolia.com/wordpress/customize-autocomplete.html).
     74- For extending or theming the Instant Search results page, see our [Search Page Customization guide](https://community.algolia.com/wordpress/customize-search-page.html).
     75
     76= Will it work with my theme? =
     77
     78Yes. This plugin will work with any theme, but the Instant Search results page may require some styling to make it match nicely. See the [Search Page Customization](https://community.algolia.com/wordpress/customize-search-page.html).
     79
     80= Where can I report bugs, request features, or contribute to the project? =
     81
     82Bugs can be reported on our [GitHub repository](https://github.com/WebDevStudios/wp-search-with-algolia/issues).
     83
     84== About Algolia ==
     85Algolia offers its Search as a Service provider on a incremental payment program, including a free Community Plan which includes 10,000 records & 50,000 operations per month. Beyond that, [plans](https://www.algolia.com/pricing/) start at $29/month.
     86
     87*Note: there isn't a direct correlation between the number of posts in WordPress and the number of records in Algolia. Also note that we only offer support starting from the PRO plan.On average, you can expect to have about 10 times more records than you have posts, though this is not a golden rule and you could end up with more records.*
     88
     89== About WebDevStudios ==
     90WebDevStudios provides end-to-end WordPress opportunities from strategy and planning to website design and development, as well as full data migration, extensive API integrations, scalability, performance and long-term guidance and maintenance. We have service options and solutions for start-ups, small to mid-size businesses, enterprise organizations and marketing agencies.
    8591
    8692== Screenshots ==
     
    94100== Changelog ==
    95101
    96 [Checkout the complete changelog here](https://github.com/WebDevStudios/wp-search-with-algolia/releases).
     102Follow along with the changelog on [Github](https://github.com/WebDevStudios/wp-search-with-algolia/releases).
     103
     104=== WP Search with Algolia ===
     105Contributors: WebDevStudios, williamsba1, gregrickaby, tw2113
     106Tags: Search, Algolia, Autocomplete, instant-search, relevant search, search highlight, faceted search, find-as-you-type search, suggest, search by category, ajax search, better search, custom search
     107Requires at least: 4.4
     108Tested up to: 5.2
     109Requires PHP: 5.6
     110Stable tag: 1.0.0
     111License: GNU General Public License v2.0, MIT License
     112
     113Improve search on your site. Autocomplete is included, along with full control over look, feel and relevance.
     114
     115== Description ==
     116
     117Improve search on your site. Autocomplete is included, along with full control over look, feel and relevance.
     118
     119Features:
     120- Relevant search results in milliseconds
     121- Native typo-tolerance
     122- Is language-agnostic
     123- Offers hooks and filters for easy customization
     124- Built by developers, for developers
     125
     126*The following code is a derivative work of the code from the Algolia Search plugin for WordPress, which is licensed GPLv2.*
     127
     128== Requirements ==
     129
     130This plugin requires API keys from [Algolia](https://www.algolia.com/). API keys are free for small personal projects and non-commercial use. Learn more about [commercial use pricing](https://www.algolia.com/pricing/).
     131
     132== Installation ==
     133
     134= Minimum Requirements =
     135
     136* Requires WordPress 4.4+
     137* PHP version 5.6 or greater (PHP 7.0 or greater is recommended)
     138* MySQL version 5.0 or greater (MySQL 5.6 or greater is recommended)
     139* cURL PHP extension
     140* mbstring PHP extension
     141* OpenSSL greater than 1.0.1
     142* Some payment gateways require fsockopen support (for IPN access)
     143
     144Visit the [Search by Algolia server requirements documentation](https://community.algolia.com/wordpress/installation.html) for a detailed list of server requirements.
     145
     146= Automatic installation =
     147Upload the WP Search with Algolia plugin to your site, Activate it, then enter your your Algolia API keys.
     148
     149== Getting started guide ==
     150Once you have installed the plugin, you can follow the [step by step guide](https://community.algolia.com/wordpress/configuration.html).
     151
     152== Frequently Asked Questions ==
     153
     154= Is this plugin a fork? =
     155Yes. The Algolia Team **[no longer supports their original plugin](https://community.algolia.com/wordpress/)**. The engineering team at WebDevStudios has forked the original plugin, and is now maintaining it.
     156
     157= Should I switch to this plugin? =
     158Yes. As long as you enter your API keys, everything should work the same.
     159
     160= Where can I find Algolia documentation and user guides? =
     161
     162- For help setting up and configuring Search by Algolia please refer to our [user guide](https://community.algolia.com/wordpress/installation.html).
     163- For extending or theming the Autocomplete dropdown, see our [Autocomplete Customization guide](https://community.algolia.com/wordpress/customize-autocomplete.html).
     164- For extending or theming the Instant Search results page, see our [Search Page Customization guide](https://community.algolia.com/wordpress/customize-search-page.html).
     165
     166= Will it work with my theme? =
     167
     168Yes. This plugin will work with any theme, but the Instant Search results page may require some styling to make it match nicely. See the [Search Page Customization](https://community.algolia.com/wordpress/customize-search-page.html).
     169
     170= Where can I report bugs or contribute to the project? =
     171
     172Bugs can be reported on our [GitHub repository](https://github.com/WebDevStudios/wp-search-with-algolia/issues).
     173
     174== About Algolia ==
     175
     176Algolia offers its Search as a Service provider on a incremental payment program, including a free Community Plan which includes 10,000 records & 50,000 operations per month. Beyond that, plans start at $29/month.
     177
     178Note that there isn't a direct correlation between the number of posts in WordPress and the number of records in Algolia. Also note that we only offer support starting from the PRO plan.On average, you can expect to have about 10 times more records than you have posts, though this is not a golden rule and you could end up with more records.
     179
     180== About WebDevStudios ==
     181
     182WebDevStudios provides end-to-end WordPress opportunities from strategy and planning to website design and development, as well as full data migration, extensive API integrations, scalability, performance and long-term guidance and maintenance. We have service options and solutions for start-ups, small to mid-size businesses, enterprise organizations and marketing agencies. mispellled workd
     183
     184== Screenshots ==
     185
     1861. Algolia Settings.
     1872. Search Page Settings.
     1883. Autocomplete Settings.
     1894. InstantSearch Dropdown.
     1905. Search Results.
     191
     192== Changelog ==
     193
     194Follow along with the changelog on [Github](https://github.com/WebDevStudios/wp-search-with-algolia/releases).
  • wp-search-with-algolia/trunk/README.txt

    r2092384 r2092431  
     1
    12=== WP Search with Algolia ===
    23Contributors: WebDevStudios, williamsba1, gregrickaby, tw2113
     
    1213== Description ==
    1314
    14 The plugin provides relevant search results in milliseconds, ensuring that your users can find your best posts at the speed of thought. It also comes with native typo-tolerance and is language-agnostic, so that every WordPress user, no matter where they are, can benefit from it.
     15Improve search on your site. Autocomplete is included, along with full control over look, feel and relevance.
     16
     17Features:
     18- Relevant search results in milliseconds
     19- Native typo-tolerance
     20- Is language-agnostic
     21- Offers hooks and filters for easy customization
     22- Built by developers, for developers
    1523
    1624*The following code is a derivative work of the code from the Algolia Search plugin for WordPress, which is licensed GPLv2.*
    1725
    18 = About pricing =
     26== Requirements ==
    1927
    20 This plugin relies on the [Algolia service](https://www.algolia.com/) which requires you to [create an account here](https://www.algolia.com/users/sign_up). Algolia offers its Search as a Service provider on a incremental payment program, including a free Community Plan which includes 10,000 records & 50,000 operations per month. Beyond that, plans start at $29/month.
    21 
    22 Note that there isn’t a direct correlation between the number of posts in WordPress and the number of records in Algolia. Also note that we only offer support starting from the PRO plan.On average, you can expect to have about 10 times more records than you have posts, though this is not a golden rule and you could end up with more records.
    23 
    24 = Getting started guide =
    25 Once you have installed the plugin, you can follow the step by step guide provided here: https://community.algolia.com/wordpress/configuration.html
    26 
    27 = Relevance =
    28 Algolia enhances your search functionality with a completely customizable search experience which can be seamlessly integrated into your Wordpress theme. It lets you create a find-as-you-type experience or an auto-complete dropdown menu, which provides relevant results from the first keystroke. Our extension also automatically synchronizes data (posts, taxonomies etc.) in real-time, making sure that any updates to your site are available as soon as they are made.
    29 
    30 = Speed =
    31 Algolia returns results in under 35ms on an average – irrespective of whether you have 100s or 1000s of posts. Our state-of-the-art infrastructure and distributed search network ensures that your readers benefit from this, no matter where they are.
    32 
    33 = Accessibility =
    34 WDS Search with Algolia gives you the ability to make all forms of data – blog posts, categories, users etc. – searchable from a single search bar. Algolia also gives you the ability to completely customize your search results based on criteria that makes sense for your business, such as popularity, date, relevance etc.
    35 
    36 = Built by developers for developers =
    37 WDS Search with Algolia is also completely configurable and fully extensible by means of WordPress filters and hooks, letting you build a custom search experience or theme based on Algolia.
    38 
    39 Want to see out how we did it?
    40 
    41 Check it out here: [GitHub Repository](https://github.com/WebDevStudios/wp-search-with-algolia)
    42 
    43 Join the Algolia community and meet thousands of search enthusiasts. https://community.algolia.com/
    44 
    45 == Frequently Asked Questions ==
    46 
    47 = Where can I find Algolia documentation and user guides? =
    48 
    49 - For help setting up and configuring Search by Algolia please refer to our [user guide](https://community.algolia.com/wordpress/installation.html)
    50 - For extending or theming the Autocomplete dropdown, see our [Autocomplete Customization guide](https://community.algolia.com/wordpress/customize-autocomplete.html).
    51 - For extending or theming the Instant Search results page, see our [Search Page Customization guide](https://community.algolia.com/wordpress/customize-search-page.html).
    52 
    53 = Will Algolia work with my theme? =
    54 
    55 Yes; Algolia will work with any theme, but the Instant Search results page may require some styling to make it match nicely.
    56 
    57 = Where can I report bugs or contribute to the project? =
    58 
    59 Bugs can be reported either in our support forum or preferably on the [GitHub repository](https://github.com/WebDevStudios/wp-search-with-algolia/issues).
     28This plugin requires API keys from [Algolia](https://www.algolia.com/). API keys are free for small personal projects and non-commercial use. Learn more about [commercial use pricing](https://www.algolia.com/pricing/).
    6029
    6130== Installation ==
     
    6332= Minimum Requirements =
    6433
     34* Requires WordPress 4.4+
    6535* PHP version 5.6 or greater (PHP 7.0 or greater is recommended)
    6636* MySQL version 5.0 or greater (MySQL 5.6 or greater is recommended)
     37* cURL PHP extension
     38* mbstring PHP extension
     39* OpenSSL greater than 1.0.1
    6740* Some payment gateways require fsockopen support (for IPN access)
    68 * Requires WordPress 4.4+
    6941
    7042Visit the [Search by Algolia server requirements documentation](https://community.algolia.com/wordpress/installation.html) for a detailed list of server requirements.
    7143
    72 = Automatic installation =
     44= Automatic Installation =
     451. In the WP Dashboard, Click on "Plugins" --> "Add New" and search for "WP Search with Algolia"
     462. Activate
     473. *If you have the "Search by Algolia – Instant & Relevant results" plugin installed, please deactivate it first!*
     484. Enter your Algolia API keys
    7349
    74 Automatic installation is the easiest option as WordPress handles the file transfers itself and you don’t need to leave your web browser. To do an automatic install of Search by Algolia, log in to your WordPress dashboard, navigate to the Plugins menu and click Add New.
     50= Manual Installation =
     51Upload the WP Search with Algolia plugin to your site, Activate it, then Enter your Algolia API keys.
    7552
    76 In the search field type “Algolia” and click Search Plugins. Once you’ve found our search plugin you can view details about it such as the point release, rating and description. Most importantly of course, you can install it by simply clicking “Install Now”.
     53== Getting started guide ==
     54Once you have installed the plugin, you can follow the [step by step guide](https://community.algolia.com/wordpress/configuration.html).
    7755
    78 = Manual installation =
     56== Frequently Asked Questions ==
    7957
    80 The manual installation method involves downloading our search plugin and uploading it to your webserver via your favourite FTP application. The WordPress codex contains [instructions on how to do this here](https://codex.wordpress.org/Managing_Plugins#Manual_Plugin_Installation).
     58= Is this plugin a fork? =
     59Yes. The Algolia Team **[no longer supports their original plugin](https://community.algolia.com/wordpress/)**. The engineering team at WebDevStudios has forked the original plugin, and is now maintaining it.
    8160
    82 = Updating =
     61= Should I switch to this plugin? =
     62Yes. Because Algolia no longer supports their plugin, you will no longer receive updates. WebDevStudios uses Algolia on many of it's projects, and is committed to maintaining this plugin for years to come.
    8363
    84 Automatic updates should work like a charm; as always though, ensure you backup your site just in case.
     64= How do I switch? =
     651. Deactivate the "Search by Algolia – Instant & Relevant results" plugin
     662. Follow the installation instructions above
     673. Activate "WP Search with Algolia". Your API keys *should already be there*, if not enter them and save settings
     684. Delete the "Search by Algolia – Instant & Relevant results" plugin
     69
     70= Where can I find Algolia documentation and user guides? =
     71
     72- For help setting up and configuring Search by Algolia please refer to our [user guide](https://community.algolia.com/wordpress/installation.html).
     73- For extending or theming the Autocomplete dropdown, see our [Autocomplete Customization guide](https://community.algolia.com/wordpress/customize-autocomplete.html).
     74- For extending or theming the Instant Search results page, see our [Search Page Customization guide](https://community.algolia.com/wordpress/customize-search-page.html).
     75
     76= Will it work with my theme? =
     77
     78Yes. This plugin will work with any theme, but the Instant Search results page may require some styling to make it match nicely. See the [Search Page Customization](https://community.algolia.com/wordpress/customize-search-page.html).
     79
     80= Where can I report bugs, request features, or contribute to the project? =
     81
     82Bugs can be reported on our [GitHub repository](https://github.com/WebDevStudios/wp-search-with-algolia/issues).
     83
     84== About Algolia ==
     85Algolia offers its Search as a Service provider on a incremental payment program, including a free Community Plan which includes 10,000 records & 50,000 operations per month. Beyond that, [plans](https://www.algolia.com/pricing/) start at $29/month.
     86
     87*Note: there isn't a direct correlation between the number of posts in WordPress and the number of records in Algolia. Also note that we only offer support starting from the PRO plan.On average, you can expect to have about 10 times more records than you have posts, though this is not a golden rule and you could end up with more records.*
     88
     89== About WebDevStudios ==
     90WebDevStudios provides end-to-end WordPress opportunities from strategy and planning to website design and development, as well as full data migration, extensive API integrations, scalability, performance and long-term guidance and maintenance. We have service options and solutions for start-ups, small to mid-size businesses, enterprise organizations and marketing agencies.
    8591
    8692== Screenshots ==
     
    94100== Changelog ==
    95101
    96 [Checkout the complete changelog here](https://github.com/WebDevStudios/wp-search-with-algolia/releases).
     102Follow along with the changelog on [Github](https://github.com/WebDevStudios/wp-search-with-algolia/releases).
     103
     104=== WP Search with Algolia ===
     105Contributors: WebDevStudios, williamsba1, gregrickaby, tw2113
     106Tags: Search, Algolia, Autocomplete, instant-search, relevant search, search highlight, faceted search, find-as-you-type search, suggest, search by category, ajax search, better search, custom search
     107Requires at least: 4.4
     108Tested up to: 5.2
     109Requires PHP: 5.6
     110Stable tag: 1.0.0
     111License: GNU General Public License v2.0, MIT License
     112
     113Improve search on your site. Autocomplete is included, along with full control over look, feel and relevance.
     114
     115== Description ==
     116
     117Improve search on your site. Autocomplete is included, along with full control over look, feel and relevance.
     118
     119Features:
     120- Relevant search results in milliseconds
     121- Native typo-tolerance
     122- Is language-agnostic
     123- Offers hooks and filters for easy customization
     124- Built by developers, for developers
     125
     126*The following code is a derivative work of the code from the Algolia Search plugin for WordPress, which is licensed GPLv2.*
     127
     128== Requirements ==
     129
     130This plugin requires API keys from [Algolia](https://www.algolia.com/). API keys are free for small personal projects and non-commercial use. Learn more about [commercial use pricing](https://www.algolia.com/pricing/).
     131
     132== Installation ==
     133
     134= Minimum Requirements =
     135
     136* Requires WordPress 4.4+
     137* PHP version 5.6 or greater (PHP 7.0 or greater is recommended)
     138* MySQL version 5.0 or greater (MySQL 5.6 or greater is recommended)
     139* cURL PHP extension
     140* mbstring PHP extension
     141* OpenSSL greater than 1.0.1
     142* Some payment gateways require fsockopen support (for IPN access)
     143
     144Visit the [Search by Algolia server requirements documentation](https://community.algolia.com/wordpress/installation.html) for a detailed list of server requirements.
     145
     146= Automatic installation =
     147Upload the WP Search with Algolia plugin to your site, Activate it, then enter your your Algolia API keys.
     148
     149== Getting started guide ==
     150Once you have installed the plugin, you can follow the [step by step guide](https://community.algolia.com/wordpress/configuration.html).
     151
     152== Frequently Asked Questions ==
     153
     154= Is this plugin a fork? =
     155Yes. The Algolia Team **[no longer supports their original plugin](https://community.algolia.com/wordpress/)**. The engineering team at WebDevStudios has forked the original plugin, and is now maintaining it.
     156
     157= Should I switch to this plugin? =
     158Yes. As long as you enter your API keys, everything should work the same.
     159
     160= Where can I find Algolia documentation and user guides? =
     161
     162- For help setting up and configuring Search by Algolia please refer to our [user guide](https://community.algolia.com/wordpress/installation.html).
     163- For extending or theming the Autocomplete dropdown, see our [Autocomplete Customization guide](https://community.algolia.com/wordpress/customize-autocomplete.html).
     164- For extending or theming the Instant Search results page, see our [Search Page Customization guide](https://community.algolia.com/wordpress/customize-search-page.html).
     165
     166= Will it work with my theme? =
     167
     168Yes. This plugin will work with any theme, but the Instant Search results page may require some styling to make it match nicely. See the [Search Page Customization](https://community.algolia.com/wordpress/customize-search-page.html).
     169
     170= Where can I report bugs or contribute to the project? =
     171
     172Bugs can be reported on our [GitHub repository](https://github.com/WebDevStudios/wp-search-with-algolia/issues).
     173
     174== About Algolia ==
     175
     176Algolia offers its Search as a Service provider on a incremental payment program, including a free Community Plan which includes 10,000 records & 50,000 operations per month. Beyond that, plans start at $29/month.
     177
     178Note that there isn't a direct correlation between the number of posts in WordPress and the number of records in Algolia. Also note that we only offer support starting from the PRO plan.On average, you can expect to have about 10 times more records than you have posts, though this is not a golden rule and you could end up with more records.
     179
     180== About WebDevStudios ==
     181
     182WebDevStudios provides end-to-end WordPress opportunities from strategy and planning to website design and development, as well as full data migration, extensive API integrations, scalability, performance and long-term guidance and maintenance. We have service options and solutions for start-ups, small to mid-size businesses, enterprise organizations and marketing agencies. mispellled workd
     183
     184== Screenshots ==
     185
     1861. Algolia Settings.
     1872. Search Page Settings.
     1883. Autocomplete Settings.
     1894. InstantSearch Dropdown.
     1905. Search Results.
     191
     192== Changelog ==
     193
     194Follow along with the changelog on [Github](https://github.com/WebDevStudios/wp-search-with-algolia/releases).
Note: See TracChangeset for help on using the changeset viewer.