Skip to content

Commit fe2ce33

Browse files
committed
updating readme
1 parent c357460 commit fe2ce33

File tree

2 files changed

+7
-17
lines changed

2 files changed

+7
-17
lines changed

README.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,11 @@
11
# MODX SimpleSearch
2-
![SimpleSearch version](https://img.shields.io/badge/version-2.1.0-blue.svg) ![MODX Extra by Sterc](https://img.shields.io/badge/checked%20by-sterc-ff69b4.svg) ![MODX version requirements](https://img.shields.io/badge/modx%20version%20requirement-2.0%2B-brightgreen.svg)
2+
![SimpleSearch version](https://img.shields.io/badge/version-3.0.0-blue.svg) ![MODX version requirements](https://img.shields.io/badge/modx%20version%20requirement-3.0%2B-brightgreen.svg)
33

44
## Installation
55
Simply install it through the top menu ```Extras > Installer``` and search for ```SimpleSearch```. Install it from there. After installing it, it is recommended to clear your MODX cache, through the top menu ```Manage > Clear Cache```.
66

77
## Upgrade risks
8-
First of all: ALWAYS MAKE A BACKUP BEFORE UPDATING!
9-
10-
Upgrading to 2.0.0 from 1.* is highly recommended, but it does introduce some risks.
11-
12-
Important changes from 1.* to 2.0.0:
13-
- The namespace has been changed from `sisea` to `simplesearch`. If you're using custom System Settings, then please migrate them.
14-
- The placeholder prefix has also been changed from `sisea` to `simplesearch`.
15-
- The ElasticSearch and SOLR drivers have been removed, because they were in need of improvements. Future drivers should be seperate addons. Feel free to ask us for help here.
8+
This is currently alpha software and is only compatible with MODX 3.x and higher. This has been tested on basic search queries, but you may encounter problems with more advanced setups.
169

1710
## Autosuggest
1811
A processor has been provided for retrieving a list of search suggestions based on a Template Variable containing a comma delimited list of search terms.
@@ -35,9 +28,6 @@ $('.simplesearch-search-form input[type="text"]').on('keyup', function () {
3528
```
3629

3730
## Bugs and feature requests
38-
We value your feedback, feature requests and bug reports. Please issue them on [Github](https://github.com/Sterc/SimpleSearch/issues/new).
39-
40-
# Free Extra
41-
This is a free extra and the code is publicly available for you to change. The extra is being actively maintained and you're free to put in pull requests which match our roadmap. Please create an issue if the pull request differs from the roadmap so we can make sure we're on the same page.
31+
We value your feedback, feature requests and bug reports. Please issue them on [Github](https://github.com/modxcms/SimpleSearch/issues/new)..
4232

43-
Need help? [Approach our support desk for paid premium support.](mailto:service@sterc.com)
33+
Need help? [Contact MODX Help Desk](mailto:help@modx.com)
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
=====================
22
Snippet: SimpleSearch
33
=====================
4-
Version: 2.1.0
5-
Author: Sterc <modx@sterc.com>
4+
Version: 3.0.0-alpha
5+
Author: MODX LLC <help@modx.com>
66
License: GNU GPLv2 (or later at your option)
77

88
This is a simple search component. Please see the documentation at:
99
https://docs.modx.com/extras/revo/simplesearch
1010

1111
Bugs and feature requests
1212
-------------------------
13-
We value your feedback, feature requests and bug reports. Please issue them on GitHub (https://github.com/Sterc/SimpleSearch/issues/new).
13+
We value your feedback, feature requests and bug reports. Please issue them on GitHub (https://github.com/modxcms/SimpleSearch/issues/new).
1414

1515
Thanks for using SimpleSearch!

0 commit comments

Comments
 (0)