iyear · iyear · Aug 31, 2022 · Aug 4, 2022 · Aug 5, 2022 · Aug 5, 2022
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,3 @@
 .idea
-data
 log
-config/config.yaml
 .searchx
diff --git a/.goreleaser.yaml b/.goreleaser.yaml
@@ -40,12 +40,11 @@ archives:
       - goos: windows
         format: zip
     files:
-      - README.md
+      - README*.md
       - LICENSE
-      - config/i18n/*
-      - config/dict.txt
-      - config/config.full.yaml
-      - config/config.min.yaml
+      - config/**/*
+      - data/**/*
+      - docs/**/*
 changelog:
   use: github
   sort: asc

diff --git a/README.md b/README.md
@@ -1,12 +1,13 @@
 ## Introduction
+
 ![](https://img.shields.io/github/go-mod/go-version/iyear/searchx?style=flat-square)
 ![](https://img.shields.io/github/license/iyear/searchx?style=flat-square)
 ![](https://img.shields.io/github/v/release/iyear/searchx?color=red&style=flat-square)
 ![](https://img.shields.io/github/last-commit/iyear/searchx?style=flat-square)
 
-English | [简体中文](README_zh.md)
+English | [简体中文](README.zh.md)
 
-🔍 Enhance Telegram Group/Channel Search In 5 Minutes 🚀
+🔍 Enhance Telegram Search In 5 Minutes 🚀
 
 [DEMO](https://t.me/e5subs_bot) (Join [E5SubBot Group](https://t.me/e5subbot) in advance)
 
@@ -20,103 +21,39 @@ English | [简体中文](README_zh.md)
 - Customizable i18n message templates
 - ......
 
-## Deployment
-
-1. **Prepare `Telegram Bot`**
-    1. Get `Bot Token`: [How to create a Bot](https://core.telegram.org/bots#6-botfather)
-    2. **Disable** `Group Privacy`: send `/setprivacy` to [@BotFather](https://t.me/BotFather)
-2. **Get `Telegram User ID`: [@userinfobot](https://t.me/userinfobot)**
-3. **Prepare `searchx`**
-    1. Download `searchx`: go to [GitHub Releases](https://github.com/iyear/searchx/releases) and uncompress it.
-    2. Change `YOUR_BOT_TOKEN` `YOUR_ADMIN_ID` in `config/config.min.yaml` to `Bot Token` `Telegram User ID`
-4. **Start: `./searchx run -c config/config.min.yaml`**
-5. **Invite `Bot` to groups/channels**
-
-## Customization
-For the vast majority of users, the default minimal configuration is sufficient. 
-
-If you have more customization needs, please refer to [config.full.yaml](config/config.full.yaml) and its comments.
-
-## Command
-### version
-View version information
-
-```shell
-./searchx version
-```
-
-```
-Version: 0.0.0
-Commit: 5cae8dc
-Date: 2022-07-30T07:58:05Z
-
-go1.17.3 windows/amd64
-```
-
-### run
-Start Bot
-
-- `-c`: path to config file
+## Usage
 
-```shell
-# start with the minimal config
-./searchx run -c config/config.min.yaml
-```
+In versions after `v0.2.0`, `searchx` combines `bot` and `usr`.
 
-### source
-Bot only indexes messages during the join period, use this command if you want to index history messages. 
+`bot` is used by channel owners/group owners to provide members with an enhanced search function.
 
-Support groups/channels, support very large `JSON` file.
+`usr` is used by individual users to provide enhanced search functionality for themselves.
 
-Use **official client** to export history messages. Export options: **Uncheck all, format as `JSON`**.
+[bot document](docs/bot/README.md) | [usr document](docs/usr/README.md)
 
-- `-f`: exported history messages in `JSON` file
-- `-d`: search engine driver
-- `-o`: search engine options
+## Commands
 
-```shell
-# Using bleve to import messages
-./searchx source -f YOUR_PATH/result.json -d bleve -o path="index" -o dict="config/dict.txt"
-```
-
-### query
-Command line query
-
-- `-d`: search engine driver
-- `-o`: search engine options
-- `-q`: keyword
-- `--pn`: page number, start from 0, default is 0
-- `--ps`: number of result per page, default is 10
-- `--json`: output as `JSON` format
-
-```shell
-# Using bleve to query
-./searchx query -d bleve -o path="index" -o dict="config/dict.txt" -q KEYWORD --pn 0 --ps 10 --json
-```
+Go to [command documentation](docs/command/searchx.md) for full command docs.
 
 ## FAQ
+
 **Q: Why don't I use the search that comes with Telegram?**
 
-A: As we all know, the search function that comes with Telegram is not very useful. The purpose of this project is to solve these problems.
+A: As we all know, the search function that comes with Telegram is not very useful. The purpose of this project is to
+solve these problems.
 
 **Q: I'm having problems using it?**
 
-A: If you still can't solve the problem after searching, give feedback by [SUBMIT ISSUE](https://github.com/iyear/searchx/issues/new).
+A: If you still can't solve the problem after searching, give feedback
+by [SUBMIT ISSUE](https://github.com/iyear/searchx/issues/new).
 
-When submit an `ISSUE`, we recommend describing the problem in English and providing relevant screenshots and steps to reproduce it.
+When submit an `ISSUE`, we recommend describing the problem in English and providing relevant screenshots and steps to
+reproduce it.
 
 **Q: I want to add a feature?**
 
 A: Same as above
 
-**Q: Why do I need to disable `Group Privacy`? Does it cause security issues?**
-
-A: When `Group Privacy` is enabled, it will cause `Bot` to not receive all messages in the group, resulting in missing indexes. Please refer to: https://core.telegram.org/bots#privacy-mode
-At the same time, it does not create security issues. The project is self-deployed and the data is stored locally, so it will not lead to data leakage.
-
-**Q: Can I use it for my personal account? Will it be supported in the future?**
-
-A: Not currently, it may be supported in the future, but the use of `userbot` has the risk of blocking. The current target group of this project is group/channel owners, self-built to provide convenience to members.
-
 ## LICENSE
+
 Apache License 2.0
diff --git a/README.zh.md b/README.zh.md
@@ -0,0 +1,55 @@
+## 简介
+
+![](https://img.shields.io/github/go-mod/go-version/iyear/searchx?style=flat-square)
+![](https://img.shields.io/github/license/iyear/searchx?style=flat-square)
+![](https://img.shields.io/github/v/release/iyear/searchx?color=red&style=flat-square)
+![](https://img.shields.io/github/last-commit/iyear/searchx?style=flat-square)
+
+[English](README.md) | 简体中文
+
+🔎 五分钟强化 Telegram 搜索 🚀
+
+[DEMO](https://t.me/e5subs_bot) (需先加入[E5SubBot交流群](https://t.me/e5subbot))
+
+## 特性
+
+- 最小化配置 & 单文件一键启动，轻松运行在你的路由器上
+- 组件化扩展设计，可选多种存储后端
+- 跨平台支持 macOS/Windows/Linux
+- 特别为中文优化的搜索引擎
+- 大文件历史消息导入
+- 自定义国际化消息模板
+- ……
+
+## 使用
+
+在 `v0.2.0` 之后的版本，`searchx` 将 `bot` `usr` 集于一身。
+
+`bot` 的目标群体为频道主/群主，为成员提供该会话的强化搜索功能；
+
+`usr` 的目标群体为个人用户，为自己提供强化搜索功能。
+
+[bot 文档](docs/bot/README.zh.md) | [usr 文档](docs/usr/README.zh.md)
+
+## 命令
+
+前往 [命令文档](docs/command/searchx.md) 查看完整命令文档
+
+## FAQ
+
+**Q: 为什么我不使用 Telegram 自带的搜索？**
+
+A: 众所周知，Telegram 自带的搜索功能并不好用，尤其是对中文的支持很差。本项目的目的就是解决这些搜索痛点。
+
+**Q: 我在使用过程中遇到了问题？**
+A: 在确认搜索后依旧无法解决，通过 [发起 ISSUE](https://github.com/iyear/searchx/issues/new) 的方式反馈。
+
+在发起 `ISSUE` 的过程中，我们提倡使用英文描述问题，并在 `ISSUE` 中提供相关的截图和复现步骤。
+
+**Q: 我想要增加一个功能？**
+
+A: 同上
+
+## LICENSE
+
+Apache License 2.0
diff --git a/README_zh.md b/README_zh.md
diff --git a/app/bot/internal/config/config.go b/app/bot/internal/config/config.go
@@ -0,0 +1,31 @@
+package config
+
+import (
+	"github.com/iyear/searchx/pkg/configs"
+	"github.com/iyear/searchx/pkg/logger"
+	"github.com/iyear/searchx/pkg/storage"
+)
+
+var C config
+
+func Init(path string) error {
+	return configs.Init(path, &C)
+}
+
+type config struct {
+	Bot struct {
+		Token string  `mapstructure:"token" validate:"required"`
+		Admin []int64 `mapstructure:"admin" validate:"required"`
+	} `mapstructure:"bot"`
+	Proxy   string         `mapstructure:"proxy" validate:"omitempty,url"`
+	Storage storage.Config `mapstructure:"storage"`
+	Log     logger.Config  `mapstructure:"log"`
+	Ctrl    struct {
+		Notice          string `mapstructure:"notice" default:"NO NOTICE"`
+		I18N            string `mapstructure:"i18n" validate:"dir" default:"config/bot/i18n"`
+		DefaultLanguage string `mapstructure:"default_language" validate:"iso6391" default:"zh-cn"`
+		Search          struct {
+			PageSize int `mapstructure:"page_size" validate:"gte=1,lte=20" default:"10"`
+		} `mapstructure:"search"`
+	} `mapstructure:"ctrl"`
+}