Commit856ceb7

committed

chore: update readme, add plugin install instructions

1 parent38bc426 commit856ceb7Copy full SHA for 856ceb7

File tree

+23

-2

lines changed

+23

-2

lines changed

Lines changed: 23 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -3,11 +3,32 @@ IK Analysis for Elasticsearch and OpenSearch`
`3`	`3`
`4`	`4`	`![](./assets/banner.png)`
`5`	`5`
`6`		`-The IK Analysis plugin integrates Lucene IK analyzer, and support customized dictionary. It supports major versions of Elasticsearch and OpenSearch. Maintained and supported with ❤️ by INFINI Labs.`
	`6`	`+The IK Analysis plugin integrates Lucene IK analyzer, and support customized dictionary. It supports major versions of Elasticsearch and OpenSearch. Maintained and supported with ❤️ by[INFINI Labs](https://infinilabs.com).`
`7`	`7`
`8`	`8`	The plugin comprises analyzer:`ik_smart` ,`ik_max_word`, and tokenizer:`ik_smart` ,`ik_max_word`
`9`	`9`
`10`		`-#Quick Start`
	`10`	`+#How to Install`
	`11`	`+`
	`12`	+You can download the packaged plugins from here:`https://release.infinilabs.com/`,
	`13`	`+`
	`14`	+or you can use the`plugin` cli to install the plugin like this:
	`15`	`+`
	`16`	`+For Elasticsearch`
	`17`	`+`
	`18`	+```
	`19`	`+bin/elasticsearch-plugin install https://get.infini.cloud/elasticsearch/analysis-ik/8.4.1`
	`20`	+```
	`21`	`+`
	`22`	`+For OpenSearch`
	`23`	`+`
	`24`	+```
	`25`	`+bin/opensearch-plugin install https://get.infini.cloud/opensearch/analysis-ik/2.12.0`
	`26`	+```
	`27`	`+`
	`28`	`+Tips: replace your own version number related to your elasticsearch or opensearch.`
	`29`	`+`
	`30`	`+`
	`31`	`+#Getting Started`
`11`	`32`
`12`	`33`	`1.create a index`
`13`	`34`

Comments

(0)