WordPress.org
Get WordPress

Plugin Directory

Changeset 2092452


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

remove duplicate entries in readme

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

Legend:

Unmodified
Added
Removed

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

    r2092431 r2092452  
    1515Improve search on your site. Autocomplete is included, along with full control over look, feel and relevance.
    1616
    17 Features:
    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
     17= Features =
     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
     23
     24This 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/).
    2325
    2426*The following code is a derivative work of the code from the Algolia Search plugin for WordPress, which is licensed GPLv2.*
    2527
    26 == Requirements ==
    27 
    28 This 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/).
    29 
    3028== Installation ==
    3129
    32 = Minimum Requirements =
     30**If you have the *Search by Algolia – Instant & Relevant results* plugin installed, please deactivate it first.**
     31
     32From your WordPress dashboard
     33
     341. **Visit** Plugins > Add New
     352. **Search** for "WP Search with Algolia"
     363. **Activate** WP Search with Algolia from your Plugins page
     374. **Click** on the new menu item "Algolia Search" and enter your API keys
     385. **Read** the step by step [configuration guide](https://community.algolia.com/wordpress/configuration.html)
     39
     40== Frequently Asked Questions ==
     41
     42= Is this plugin a fork? =
     43
     44Yes. 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.
     45
     46= Should I switch to this plugin? =
     47
     48Yes. 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.
     49
     50= How do I switch from the *Search by Algolia – Instant & Relevant results* plugin? =
     51
     521. Deactivate the *Search by Algolia – Instant & Relevant results* plugin
     532. Follow the [installation instructions](https://wordpress.org/plugins/wp-search-with-algolia/#installation)
     543. Activate "WP Search with Algolia". Your API keys *should already be there*, if not enter them and then save settings
     554. Delete the *Search by Algolia – Instant & Relevant results* plugin
     56
     57= What are the minimum requirements? =
    3358
    3459* Requires WordPress 4.4+
    … …  
    4166
    4267Visit the [Search by Algolia server requirements documentation](https://community.algolia.com/wordpress/installation.html) for a detailed list of server requirements.
    43 
    44 = Automatic Installation =
    45 1. In the WP Dashboard, Click on "Plugins" --> "Add New" and search for "WP Search with Algolia"
    46 2. Activate
    47 3. *If you have the "Search by Algolia – Instant & Relevant results" plugin installed, please deactivate it first!*
    48 4. Enter your Algolia API keys
    49 
    50 = Manual Installation =
    51 Upload the WP Search with Algolia plugin to your site, Activate it, then Enter your Algolia API keys.
    52 
    53 == Getting started guide ==
    54 Once you have installed the plugin, you can follow the [step by step guide](https://community.algolia.com/wordpress/configuration.html).
    55 
    56 == Frequently Asked Questions ==
    57 
    58 = Is this plugin a fork? =
    59 Yes. 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.
    60 
    61 = Should I switch to this plugin? =
    62 Yes. 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.
    63 
    64 = How do I switch? =
    65 1. Deactivate the "Search by Algolia – Instant & Relevant results" plugin
    66 2. Follow the installation instructions above
    67 3. Activate "WP Search with Algolia". Your API keys *should already be there*, if not enter them and save settings
    68 4. Delete the "Search by Algolia – Instant & Relevant results" plugin
    6968
    7069= Where can I find Algolia documentation and user guides? =
    … …  
    8281Bugs can be reported on our [GitHub repository](https://github.com/WebDevStudios/wp-search-with-algolia/issues).
    8382
    84 == About Algolia ==
     83= About Algolia =
     84
    8585Algolia 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.
    8686
    8787*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.*
    8888
    89 == About WebDevStudios ==
     89= About WebDevStudios =
     90
    9091WebDevStudios 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.
    9192
    … …  
    101102
    102103Follow along with the changelog on [Github](https://github.com/WebDevStudios/wp-search-with-algolia/releases).
    103 
    104 === WP Search with Algolia ===
    105 Contributors: WebDevStudios, williamsba1, gregrickaby, tw2113
    106 Tags: 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
    107 Requires at least: 4.4
    108 Tested up to: 5.2
    109 Requires PHP: 5.6
    110 Stable tag: 1.0.0
    111 License: GNU General Public License v2.0, MIT License
    112 
    113 Improve search on your site. Autocomplete is included, along with full control over look, feel and relevance.
    114 
    115 == Description ==
    116 
    117 Improve search on your site. Autocomplete is included, along with full control over look, feel and relevance.
    118 
    119 Features:
    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 
    130 This 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 
    144 Visit 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 =
    147 Upload the WP Search with Algolia plugin to your site, Activate it, then enter your your Algolia API keys.
    148 
    149 == Getting started guide ==
    150 Once 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? =
    155 Yes. 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? =
    158 Yes. 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 
    168 Yes. 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 
    172 Bugs can be reported on our [GitHub repository](https://github.com/WebDevStudios/wp-search-with-algolia/issues).
    173 
    174 == About Algolia ==
    175 
    176 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.
    177 
    178 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.
    179 
    180 == About WebDevStudios ==
    181 
    182 WebDevStudios 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 
    186 1. Algolia Settings.
    187 2. Search Page Settings.
    188 3. Autocomplete Settings.
    189 4. InstantSearch Dropdown.
    190 5. Search Results.
    191 
    192 == Changelog ==
    193 
    194 Follow along with the changelog on [Github](https://github.com/WebDevStudios/wp-search-with-algolia/releases).

  • wp-search-with-algolia/trunk/README.txt

    r2092431 r2092452  
    1515Improve search on your site. Autocomplete is included, along with full control over look, feel and relevance.
    1616
    17 Features:
    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
     17= Features =
     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
     23
     24This 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/).
    2325
    2426*The following code is a derivative work of the code from the Algolia Search plugin for WordPress, which is licensed GPLv2.*
    2527
    26 == Requirements ==
    27 
    28 This 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/).
    29 
    3028== Installation ==
    3129
    32 = Minimum Requirements =
     30**If you have the *Search by Algolia – Instant & Relevant results* plugin installed, please deactivate it first.**
     31
     32From your WordPress dashboard
     33
     341. **Visit** Plugins > Add New
     352. **Search** for "WP Search with Algolia"
     363. **Activate** WP Search with Algolia from your Plugins page
     374. **Click** on the new menu item "Algolia Search" and enter your API keys
     385. **Read** the step by step [configuration guide](https://community.algolia.com/wordpress/configuration.html)
     39
     40== Frequently Asked Questions ==
     41
     42= Is this plugin a fork? =
     43
     44Yes. 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.
     45
     46= Should I switch to this plugin? =
     47
     48Yes. 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.
     49
     50= How do I switch from the *Search by Algolia – Instant & Relevant results* plugin? =
     51
     521. Deactivate the *Search by Algolia – Instant & Relevant results* plugin
     532. Follow the [installation instructions](https://wordpress.org/plugins/wp-search-with-algolia/#installation)
     543. Activate "WP Search with Algolia". Your API keys *should already be there*, if not enter them and then save settings
     554. Delete the *Search by Algolia – Instant & Relevant results* plugin
     56
     57= What are the minimum requirements? =
    3358
    3459* Requires WordPress 4.4+
    … …  
    4166
    4267Visit the [Search by Algolia server requirements documentation](https://community.algolia.com/wordpress/installation.html) for a detailed list of server requirements.
    43 
    44 = Automatic Installation =
    45 1. In the WP Dashboard, Click on "Plugins" --> "Add New" and search for "WP Search with Algolia"
    46 2. Activate
    47 3. *If you have the "Search by Algolia – Instant & Relevant results" plugin installed, please deactivate it first!*
    48 4. Enter your Algolia API keys
    49 
    50 = Manual Installation =
    51 Upload the WP Search with Algolia plugin to your site, Activate it, then Enter your Algolia API keys.
    52 
    53 == Getting started guide ==
    54 Once you have installed the plugin, you can follow the [step by step guide](https://community.algolia.com/wordpress/configuration.html).
    55 
    56 == Frequently Asked Questions ==
    57 
    58 = Is this plugin a fork? =
    59 Yes. 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.
    60 
    61 = Should I switch to this plugin? =
    62 Yes. 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.
    63 
    64 = How do I switch? =
    65 1. Deactivate the "Search by Algolia – Instant & Relevant results" plugin
    66 2. Follow the installation instructions above
    67 3. Activate "WP Search with Algolia". Your API keys *should already be there*, if not enter them and save settings
    68 4. Delete the "Search by Algolia – Instant & Relevant results" plugin
    6968
    7069= Where can I find Algolia documentation and user guides? =
    … …  
    8281Bugs can be reported on our [GitHub repository](https://github.com/WebDevStudios/wp-search-with-algolia/issues).
    8382
    84 == About Algolia ==
     83= About Algolia =
     84
    8585Algolia 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.
    8686
    8787*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.*
    8888
    89 == About WebDevStudios ==
     89= About WebDevStudios =
     90
    9091WebDevStudios 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.
    9192
    … …  
    101102
    102103Follow along with the changelog on [Github](https://github.com/WebDevStudios/wp-search-with-algolia/releases).
    103 
    104 === WP Search with Algolia ===
    105 Contributors: WebDevStudios, williamsba1, gregrickaby, tw2113
    106 Tags: 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
    107 Requires at least: 4.4
    108 Tested up to: 5.2
    109 Requires PHP: 5.6
    110 Stable tag: 1.0.0
    111 License: GNU General Public License v2.0, MIT License
    112 
    113 Improve search on your site. Autocomplete is included, along with full control over look, feel and relevance.
    114 
    115 == Description ==
    116 
    117 Improve search on your site. Autocomplete is included, along with full control over look, feel and relevance.
    118 
    119 Features:
    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 
    130 This 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 
    144 Visit 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 =
    147 Upload the WP Search with Algolia plugin to your site, Activate it, then enter your your Algolia API keys.
    148 
    149 == Getting started guide ==
    150 Once 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? =
    155 Yes. 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? =
    158 Yes. 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 
    168 Yes. 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 
    172 Bugs can be reported on our [GitHub repository](https://github.com/WebDevStudios/wp-search-with-algolia/issues).
    173 
    174 == About Algolia ==
    175 
    176 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.
    177 
    178 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.
    179 
    180 == About WebDevStudios ==
    181 
    182 WebDevStudios 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 
    186 1. Algolia Settings.
    187 2. Search Page Settings.
    188 3. Autocomplete Settings.
    189 4. InstantSearch Dropdown.
    190 5. Search Results.
    191 
    192 == Changelog ==
    193 
    194 Follow 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.