Skip to content

Commit 4526b8f

Browse files
committed
Docs: make the welcome page more obvious
Closes #39.
1 parent d794dcf commit 4526b8f

File tree

5 files changed

+157
-807
lines changed

5 files changed

+157
-807
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@
99
/.settings
1010
/.classpath
1111
/.local-execution-hints.log
12+
/plugin_tools

README.md

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,34 @@ Japanese (kuromoji) Analysis for Elasticsearch
33

44
The Japanese (kuromoji) Analysis plugin integrates Lucene kuromoji analysis module into elasticsearch.
55

6-
In order to install the plugin, simply run: `bin/plugin -install elasticsearch/elasticsearch-analysis-kuromoji/2.1.0`.
6+
In order to install the plugin, run:
77

8-
* For master elasticsearch versions, look at [master branch](https://github.com/elasticsearch/elasticsearch-analysis-kuromoji/tree/master).
9-
* For 1.4.x elasticsearch versions, look at [es-1.4 branch](https://github.com/elasticsearch/elasticsearch-analysis-kuromoji/tree/es-1.4).
10-
* For 1.3.x elasticsearch versions, look at [es-1.3 branch](https://github.com/elasticsearch/elasticsearch-analysis-kuromoji/tree/es-1.3).
11-
* For 1.2.x elasticsearch versions, look at [es-1.2 branch](https://github.com/elasticsearch/elasticsearch-analysis-kuromoji/tree/es-1.2).
12-
* For 1.1.x elasticsearch versions, look at [es-1.1 branch](https://github.com/elasticsearch/elasticsearch-analysis-kuromoji/tree/es-1.1).
13-
* For 1.0.x elasticsearch versions, look at [es-1.0 branch](https://github.com/elasticsearch/elasticsearch-analysis-kuromoji/tree/es-1.0).
14-
* For 0.90.x elasticsearch versions, look at [es-0.90 branch](https://github.com/elasticsearch/elasticsearch-analysis-kuromoji/tree/es-0.90).
15-
16-
17-
| Kuromoji Analysis Plugin | elasticsearch | Release date |
18-
|-----------------------------|---------------------|:------------:|
19-
| 3.0.0-SNAPSHOT | master (2.x) | XXXX-XX-XX |
8+
```sh
9+
bin/plugin -install elasticsearch/elasticsearch-analysis-kuromoji/2.3.0`
10+
```
2011

21-
Please read documentation relative to the version you are using:
12+
You need to install a version matching your Elasticsearch version:
2213

23-
* [3.0.0-SNAPSHOT](https://github.com/elasticsearch/elasticsearch-analysis-kuromoji/blob/master/README.md)
14+
| elasticsearch | Kuromoji Analysis Plugin | Docs |
15+
|---------------|-----------------------------|------------|
16+
| master | Build from source | See below |
17+
| es-1.x | Build from source | [2.4.0-SNAPSHOT](https://github.com/elasticsearch/elasticsearch-analysis-kuromoji/tree/es-1.x/#version-240-snapshot-for-elasticsearch-1x) |
18+
| es-1.3 | 2.3.0 | [2.3.0](https://github.com/elasticsearch/elasticsearch-analysis-kuromoji/tree/v2.3.0/#japanese-kuromoji-analysis-for-elasticsearch) |
19+
| es-1.2 | 2.2.0 | [2.2.0](https://github.com/elasticsearch/elasticsearch-analysis-kuromoji/tree/v2.2.0/#japanese-kuromoji-analysis-for-elasticsearch) |
20+
| es-1.1 | 2.1.0 | [2.1.0](https://github.com/elasticsearch/elasticsearch-analysis-kuromoji/tree/v2.1.0/#japanese-kuromoji-analysis-for-elasticsearch) |
21+
| es-1.0 | 2.0.0 | [2.0.0](https://github.com/elasticsearch/elasticsearch-analysis-kuromoji/tree/v2.0.0/#japanese-kuromoji-analysis-for-elasticsearch) |
22+
| es-0.90 | 1.8.0 | [1.8.0](https://github.com/elasticsearch/elasticsearch-analysis-kuromoji/tree/v1.8.0/#japanese-kuromoji-analysis-for-elasticsearch) |
2423

24+
To build a `SNAPSHOT` version, you need to build it with Maven:
2525

26-
The plugin includes the `kuromoji` analyzer.
26+
```bash
27+
mvn clean install
28+
plugin --install analysis-kuromoji \
29+
--url file:target/releases/elasticsearch-analysis-kuromoji-X.X.X-SNAPSHOT.zip
30+
```
2731

28-
Includes Analyzer, Tokenizer, TokenFilter
29-
----------------------------------------
32+
Includes Analyzer, Tokenizer, TokenFilter, CharFilter
33+
-----------------------------------------------
3034

3135
The plugin includes these analyzer and tokenizer, tokenfilter.
3236

0 commit comments

Comments
 (0)