Skip to content

Commit 76194f4

Browse files
committed
Update docs to emphasis integration module requirement
1 parent 4d6cc16 commit 76194f4

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,15 @@ between services.
2727

2828
## Installation
2929

30+
**Note:** this module does not function without an
31+
[integration module](#available-service-integration-modules)
32+
33+
If you want to install this module for developing your own integration module, then you can install it with:
34+
3035
```
3136
composer require "silverstripe/silverstripe-discoverer"
3237
```
3338

34-
*Note* this module is not functional without an
35-
[integration module](#available-service-integration-modules)
36-
3739
If you are planning to search through a page and controller, then you might also want to consider using
3840
[Silverstripe Discoverer > Search UI](https://github.com/silverstripeltd/silverstripe-discoverer-search-ui)
3941

docs/simple-usage.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
# Simple usage
22

3+
**Note:** this module does not function without an
4+
[integration module](#available-service-integration-modules)
5+
36
This module does not provide a search results page out of the box. Why? Because we do not want to prescribe the way that
47
you have to interact with search.
58

69
That said, below we have some examples on how you could set up search using a basic Page (managed through the CMS like
710
any other Page), and Controller.
811

9-
**Note:** If you read through these examples, and you think they fit your use case, then you might want to consider
10-
using [Silverstripe Discoverer > Search UI](https://github.com/silverstripeltd/silverstripe-discoverer-search-ui),
12+
**Note:** If these examples fit your use case, then you might want to consider using
13+
[Silverstripe Discoverer > Search UI](https://github.com/silverstripeltd/silverstripe-discoverer-search-ui),
1114
as this module provides most of what is described below out of the box.
1215

1316
* [`SearchResults.php`](#searchresultsphp)

0 commit comments

Comments
 (0)