Skip to content

Commit 22678a2

Browse files
committed
Update README and add keywords to composer.json
1 parent 5e2da3a commit 22678a2

2 files changed

Lines changed: 29 additions & 6 deletions

File tree

README.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 🧭 Silverstripe Discoverer > Search Query module
1+
# 🧭 Silverstripe Discoverer > Search query module
22

33
* [Purpose](#purpose)
44
* [Delivery](#delivery)
@@ -10,26 +10,39 @@
1010

1111
## Purpose
1212

13-
To provide you (a Silverstripe developer) with interfaces for search querying that **do not change**, even when you switch between
14-
different search service providers.
13+
To provide you (a Silverstripe developer) with interfaces for search querying that **do not change**, even when you
14+
switch between different search service providers (EG: Elastic, Algolia, Silverstripe Search).
1515

1616
## Delivery
1717

1818
To deliver on our purpose, the way that you perform filtering, faceting, and certainly the way that you display
1919
results, is very likely going to change. We hope that the learning curve is reasonable, and that the majority of
2020
developer interactions with this code is intuative (once you understand the mentality behind it).
2121

22+
You will **not** be able to perform any sort of "raw filtering" or "raw querying" with service specific formats, as that
23+
would not meet the purpose of this module - which is to use a common interface that will allow you to easily switch
24+
between services.
25+
26+
## Installation
27+
28+
```
29+
composer require "silverstripe/silverstripe-discoverer"
30+
```
31+
32+
*Note* this module is not functional without an
33+
[integration module](#available-service-integration-modules)
34+
2235
## Feature support
2336

2437
Whether or not certain features are supported **by this module**. Noting that different search providers often do things
25-
in very different ways, and often have different levels of support for features. This module attempts to provide a level
38+
in different ways, and often have different levels of support for features. This module attempts to provide a level
2639
of functionality that is commonly supported by many different services.
2740

2841
| Feature | Module support | Future module support | Rationale |
2942
|-------------------------------------------------------------|----------------|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
3043
| Filters | Yes | Yes | You should (hopefully) be able to achieve any sort of nested filtering that you require. |
3144
| Facets | Partial | If desired | Facet support differs hugely between search services. Current thinking is to try and limit what sort of Facet integrations we use (EG: no Geolocation) in the hopes that if we switch services in the future, we won't lose functionality |
32-
| Multi-search | No | If desired | Not supported by many other search services. It wouldn't be unreasonable effort to add this functionality though. |
45+
| Multi-search | No | If desired | Not supported by many search services. It wouldn't be unreasonable effort to add this functionality though. |
3346
| Search suggestions (aka auto-complete, "did you mean", etc) | Yes | Yes | Features like auto-complete generate a lot of requests, and for a lower tiered shared service, that is something we want to cut down on. |
3447
| Click through logging | Yes | Yes | Supported in Elastic App Search, but not supported by many other Search Services (including Elasticsearch). This feature in particular is an example of the "silent treatment" we apply when a feature disappears between service providers |
3548

@@ -58,3 +71,8 @@ Additional documentation can also be found below:
5871
* [Detailed querying](docs/detailed-querying.md)
5972
* Lots more information about filters, facets, sorts, and (hopefully) everything else you need to know to perform
6073
whatever sort of search you require.
74+
75+
## Available service integration modules
76+
77+
* [Silverstripe Discoverer > Elastic Enterprise Search](https://github.com/silverstripeltd/silverstripe-discoverer-elastic-enterprise)
78+
* [Silverstripe Discoverer > Silverstripe Search](https://github.com/silverstripeltd/silverstripe-discoverer-bifrost)

composer.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,12 @@
1313
"keywords": [
1414
"Silverstripe",
1515
"Silverstripe CMS",
16-
"Search"
16+
"Search",
17+
"Searching",
18+
"Filter",
19+
"Filtering",
20+
"Query",
21+
"Querying"
1722
],
1823
"require": {
1924
"php": "^8.1",

0 commit comments

Comments
 (0)