Skip to content

Commit ff1c519

Browse files
committed
Docs: make the welcome page more obvious
Closes #26.
1 parent 304e689 commit ff1c519

File tree

5 files changed

+158
-802
lines changed

5 files changed

+158
-802
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: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,33 @@ Smart Chinese Analysis for Elasticsearch
33

44
The Smart Chinese Analysis plugin integrates Lucene Smart Chinese analysis module into elasticsearch.
55

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

8-
* For master elasticsearch versions, look at [master branch](https://github.com/elasticsearch/elasticsearch-analysis-smartcn/tree/master).
9-
* For 1.4.x elasticsearch versions, look at [es-1.4 branch](https://github.com/elasticsearch/elasticsearch-analysis-smartcn/tree/es-1.4).
10-
* For 1.3.x elasticsearch versions, look at [es-1.3 branch](https://github.com/elasticsearch/elasticsearch-analysis-smartcn/tree/es-1.3).
11-
* For 1.2.x elasticsearch versions, look at [es-1.2 branch](https://github.com/elasticsearch/elasticsearch-analysis-smartcn/tree/es-1.2).
12-
* For 1.1.x elasticsearch versions, look at [es-1.1 branch](https://github.com/elasticsearch/elasticsearch-analysis-smartcn/tree/es-1.1).
13-
* For 1.0.x elasticsearch versions, look at [es-1.0 branch](https://github.com/elasticsearch/elasticsearch-analysis-smartcn/tree/es-1.0).
14-
* For 0.90.x elasticsearch versions, look at [es-0.90 branch](https://github.com/elasticsearch/elasticsearch-analysis-smartcn/tree/es-0.90).
8+
```sh
9+
bin/plugin -install elasticsearch/elasticsearch-analysis-smartcn/2.3.0
10+
```
1511

16-
| Smart Chinese Analysis Plugin | elasticsearch | Release date |
17-
|-------------------------------|---------------------|:------------:|
18-
| 3.0.0-SNAPSHOT | master | XXXX-XX-XX |
1912

20-
Please read documentation relative to the version you are using:
13+
| elasticsearch | Smart Chinese Analysis Plugin | Docs |
14+
|---------------|-----------------------|------------|
15+
| master | Build from source | See below |
16+
| es-1.x | Build from source | [2.4.0-SNAPSHOT](https://github.com/elasticsearch/elasticsearch-analysis-smartcn/tree/es-1.x/#version-240-snapshot-for-elasticsearch-1x) |
17+
| es-1.3 | 2.3.0 | [2.3.0](https://github.com/elasticsearch/elasticsearch-analysis-smartcn/tree/v2.3.0/#smart-chinese-analysis-for-elasticsearch) |
18+
| es-1.2 | 2.2.0 | [2.2.0](https://github.com/elasticsearch/elasticsearch-analysis-smartcn/tree/v2.2.0/#smart-chinese-analysis-for-elasticsearch) |
19+
| es-1.1 | 2.1.0 | [2.1.0](https://github.com/elasticsearch/elasticsearch-analysis-smartcn/tree/v2.1.0/#smart-chinese-analysis-for-elasticsearch) |
20+
| es-1.0 | 2.0.0 | [2.0.0](https://github.com/elasticsearch/elasticsearch-analysis-smartcn/tree/v2.0.0/#smart-chinese-analysis-for-elasticsearch) |
21+
| es-0.90 | 1.8.0 | [1.8.0](https://github.com/elasticsearch/elasticsearch-analysis-smartcn/tree/v1.8.0/#smart-chinese-analysis-for-elasticsearch) |
2122

22-
* [3.0.0-SNAPSHOT](https://github.com/elasticsearch/elasticsearch-analysis-smartcn/blob/master/README.md)
23+
To build a `SNAPSHOT` version, you need to build it with Maven:
24+
25+
```bash
26+
mvn clean install
27+
plugin --install analysis-smartcn \
28+
--url file:target/releases/elasticsearch-analysis-smartcn-X.X.X-SNAPSHOT.zip
29+
```
30+
31+
## User guide
32+
>>>>>>> bb823d1... Docs: make the welcome page more obvious
2333
2434
The plugin includes the `smartcn` analyzer and `smartcn_tokenizer` tokenizer.
2535

0 commit comments

Comments
 (0)