Skip to content

Commit 39e97ec

Browse files
author
Alban Jubert
committed
Updated README
1 parent 1b7ca7a commit 39e97ec

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

README.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Bring the power of Elasticsearch to you Craft 3 CMS project.
1313
This plugin requires **Craft CMS 3.0.0-RC1** or later.
1414

1515
In order to index data, you will need an **Elasticsearch 6.0** (or later)
16-
instance, with the Ingest attachment processor plugin activated.
16+
instance, with the **Ingest attachment processor** plugin activated.
1717

1818

1919
## Installation
@@ -129,10 +129,10 @@ The elasticsearch configuration used to highlight query results. Only `pre_tags`
129129
For more options, refer to the [elasticsearch documentation][].
130130

131131

132-
#### `blacklistedSections`
133-
Type: _int_
132+
#### `blacklistedEntryTypes`
133+
Type: _int[]_
134134

135-
An array of section ids of which entries should not be indexed.
135+
An array of entry type ids of which entries should not be indexed.
136136

137137

138138
### Only in the configuration file
@@ -276,11 +276,23 @@ Reindex all sites
276276
````
277277

278278

279+
## About yii2-elasticsearch library
280+
281+
At the time of the release of this plugin, no stable 2.1 version of the `yiisoft/yii2-elasticsearch` was released yet. However, that version is mandatory in order to connect to Elasticsearch instances 5 or upper.
282+
283+
To simplify the installation process, a `la-haute-societe/yii2-elasticsearch` fork was made and flagged as stable. Please, note that **this fork was tested and intended to work with this plugin only**.
284+
285+
286+
## Licensing
287+
288+
This plugin is free to try in development environments, but requires payment to be used in production environments. The license fee for this plugin is $99 (license + one year of updates) via the Craft Plugin Store, then $29 per year for updates (optional).
289+
279290

280291
## Elasticsearch plugin Roadmap
281292

282293
* Handle dependencies update
283294
* Detect need for re-indexation
295+
* Switch form `la-haute-societe/yii2-elasticsearch` to official 2.1 `yiisoft/yii2-elasticsearch` library as soon as a stable version will be released
284296

285297
Brought to you by [![LHS Logo](resources/img/lhs.png) La Haute Société][lhs-site].
286298

resources/img/plugin-screenshot.png

184 KB
Loading

0 commit comments

Comments
 (0)