From 2a629ec6a9fc2c759473a648347d60108780cee3 Mon Sep 17 00:00:00 2001 From: medcl Date: Tue, 26 Mar 2024 13:05:28 +0800 Subject: [PATCH] chore: update readme, add plugin install instructions --- README.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ad82e4e..d817eac 100755 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ STConvert Analysis for Elasticsearch and OpenSearch ![](./assets/banner.png) -STConvert is analyzer that convert Chinese characters between Traditional and Simplified. It supports major versions of Elasticsearch and OpenSearch. Maintained and supported with ❤️ by INFINI Labs. +STConvert is analyzer that convert Chinese characters between Traditional and Simplified. It supports major versions of Elasticsearch and OpenSearch. Maintained and supported with ❤️ by [INFINI Labs](https://infinilabs.com). The plugin includes analyzer: `stconvert`, @@ -25,9 +25,30 @@ Supported config: - `delimiter`:default `,` -# Quick Start +# How to Install -Quick example: +You can download the packaged plugins from here: `https://release.infinilabs.com/`, + +or you can use the `plugin` cli to install the plugin like this: + +For Elasticsearch + +``` +bin/elasticsearch-plugin install https://get.infini.cloud/elasticsearch/analysis-stconvert/8.4.1 +``` + +For OpenSearch + +``` +bin/opensearch-plugin install https://get.infini.cloud/opensearch/analysis-stconvert/2.12.0 +``` + +Tips: replace your own version number related to your elasticsearch or opensearch. + + +# Getting Started + +Mapping example: ``` PUT /stconvert/