From a41d2833edd87fb08f7db693826b5ab6eb51a697 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E4=B8=80=E4=B8=9D?= <percyley@qq.com>
Date: Wed, 20 Mar 2024 21:50:19 +0800
Subject: [PATCH] doc: [jieba] add documentation for custom dictionaries

---
 packages/jieba/README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/packages/jieba/README.md b/packages/jieba/README.md
index db8672e6..07989b52 100644
--- a/packages/jieba/README.md
+++ b/packages/jieba/README.md
@@ -79,3 +79,26 @@ extract(
 //   { keyword: '天气', weight: 1.0766573240983333 }
 // ]
 ```
+
+### Load custom dictionaries
+
+```javascript
+const { loadDict, cut } = require('@node-rs/jieba')
+const customDict = [
+  '哪行 50',
+  '干一行 51',
+  '行一行 52',
+  '行行 53',
+]
+
+const dictBuffer = Buffer.from(customDict.join('\n'), 'utf-8')
+// loadDict doc: https://github.com/fxsjy/jieba?tab=readme-ov-file#%E8%BD%BD%E5%85%A5%E8%AF%8D%E5%85%B8
+loadDict(dictBuffer)
+
+const text = '人要是行干一行行一行，一行行行行行，行行行干哪行都行'
+const output = cut(text, false)
+console.log('分词结果⤵️\n', output.join('/'))
+// Before: 人/要是/行/干/一行行/一行/，/一行行/行/行/行/，/行/行/行/干/哪/行/都行
+// After:  人/要是/行/干一行/行一行/，/一行行/行行/行/，/行行/行/干/哪行/都行
+// Pinyin: rén yào shi xíng gàn yì háng xíng yì háng ， yì háng xíng háng háng xíng ， háng háng xíng gàn nǎ háng dōu xíng
+```