ai-web-search 1.0.0 → 1.0.1

package/README.md

@@ -1,80 +1,68 @@
 # AI Web Search
 
-🔍 为AI助手提供联网搜索能力的轻量级工具
+🔍 为AI助手提供联网搜索能力的轻量级工具 / A lightweight tool that enables AI assistants to search the internet
 
-## 功能特点
+## 功能特点 / Features
 
-- **开箱即用**：从GitHub克隆后 `npm install` 即可使用，无需复杂配置
+- **开箱即用**：从npm安装后即可使用，无需复杂配置
+  **Ready to use**: Install from npm and start using immediately, no complex configuration needed
 - **免费搜索**：使用 DuckDuckGo 搜索引擎，无需API密钥
+  **Free search**: Uses DuckDuckGo search engine, no API key required
 - **智能回退**：DuckDuckGo不可用时自动切换到百度搜索，确保可用性
+  **Smart fallback**: Automatically switches to Baidu search when DuckDuckGo is unavailable, ensuring availability
 - **兼容性强**：提供标准HTTP API，可与任何AI软件集成
+  **High compatibility**: Provides standard HTTP API, can be integrated with any AI software
 - **轻量快速**：启动速度快，资源占用少
+  **Lightweight and fast**: Fast startup speed, low resource usage
 - **隐私保护**：不记录搜索历史，保护用户隐私
+  **Privacy protection**: Does not record search history, protecting user privacy
 
-## 安装
+## 安装 / Installation
 
-### 方式1：从GitHub安装（推荐）
+### 方式1：通过npm安装（推荐）/ Method 1: Install via npm (Recommended)
 
 ```bash
-# 克隆仓库
-git clone https://github.com/your-username/ai-web-search.git
+# 全局安装
+npm install -g ai-web-search
 
-# 进入项目目录
-cd ai-web-search
-
-# 安装依赖
-npm install
-
-# 创建全局命令（可选）
-npm link
+# 或者本地安装
+npm install ai-web-search
 ```
 
-### 方式2：直接从GitHub安装
-
-```bash
-# 直接从GitHub安装
-npm install git+https://github.com/your-username/ai-web-search.git
-
-# 或者指定分支
-npm install git+https://github.com/your-username/ai-web-search.git#main
-```
 
-### 方式3：下载ZIP文件
 
-1. 从GitHub下载ZIP文件
-2. 解压到本地目录
-3. 进入目录运行 `npm install`
+## 快速开始 / Quick Start
 
-## 快速开始
-
-### 1. 启动服务器
+### 1. 启动服务器 / Start the server
 
 ```bash
-# 如果已创建全局命令
+# 如果已创建全局命令 / If global command is created
 ai-web-search
 
-# 或者直接运行
+# 或者直接运行 / Or run directly
 node src/index.js
 
-# 或者使用npm脚本
+# 或者使用npm脚本 / Or use npm script
 npm start
 ```
 
 服务器默认运行在 `http://localhost:3000`
+Server runs by default at `http://localhost:3000`
 
-### 2. 测试搜索
+### 2. 测试搜索 / Test search
 
 ```bash
-# 使用curl测试
+# 使用curl测试 / Test with curl
 curl "http://localhost:3000/search?query=人工智能最新发展"
 
-# 或者在浏览器中访问
+# 或者在浏览器中访问 / Or visit in browser
 http://localhost:3000/search?query=人工智能最新发展
 ```
 
-### 3. 集成到AI软件
+### 3. 集成到AI软件 / Integrate into AI software
 
 在你的AI软件中添加以下工具配置：
+Add the following tool configuration to your AI software:
 
 ```json
 {
@@ -89,25 +77,25 @@ http://localhost:3000/search?query=人工智能最新发展
 }
 ```
 
-## 配置选项
+## 配置选项 / Configuration Options
 
-### 命令行参数
+### 命令行参数 / Command Line Arguments
 
 ```bash
-ai-web-search [选项]
-
-选项：
-  -p, --port <端口>      服务器端口（默认：3000）
-  -H, --host <主机>      服务器主机（默认：localhost）
-  -d, --dev              开发模式运行
-  -s, --search-function <路径>  自定义搜索引擎模块路径
-  -h, --help             显示帮助信息
-  -v, --version          显示版本号
+ai-web-search [options]
+
+Options:
+  -p, --port <port>      Server port (default: 3000)
+  -H, --host <host>      Server host (default: localhost)
+  -d, --dev              Run in development mode
+  -s, --search-function <path>  Path to custom search function module
+  -h, --help             Show help information
+  -v, --version          Show version number
 ```
 
-### 环境变量
+### 环境变量 / Environment Variables
 
-创建 `.env` 文件：
+创建 `.env` 文件：/ Create `.env` file:
 
 ```env
 PORT=3000
@@ -116,9 +104,10 @@ RATE_LIMIT_MAX=100
 SEARCH_FUNCTION_PATH=./examples/custom-search.js
 ```
 
-### 自定义搜索引擎
+### 自定义搜索引擎 / Custom Search Engine
 
 如果默认的DuckDuckGo搜索引擎无法使用（如网络限制），你可以提供自定义搜索引擎实现。
+If the default DuckDuckGo search engine is unavailable (e.g., network restrictions), you can provide a custom search engine implementation.
 
 #### 创建自定义搜索引擎模块
 
@@ -161,23 +150,23 @@ SEARCH_FUNCTION_PATH=./custom-search.js
 
 详细的自定义搜索引擎示例请参考 `examples/custom-search.js` 文件。
 
-## API 文档
+## API 文档 / API Documentation
 
-### 搜索接口
+### 搜索接口 / Search Endpoint
 
 ```
 GET /search
 ```
 
-**参数：**
+**参数：** / **Parameters:**
 
-| 参数 | 类型 | 必需 | 默认值 | 描述 |
+| 参数 / Parameter | 类型 / Type | 必需 / Required | 默认值 / Default | 描述 / Description |
 |------|------|------|--------|------|
-| query | string | 是 | - | 搜索查询关键词 |
-| limit | integer | 否 | 5 | 返回结果数量（1-20） |
-| type | string | 否 | web | 搜索类型：web（网页）或 news（新闻） |
+| query | string | 是 / Yes | - | 搜索查询关键词 / Search query keyword |
+| limit | integer | 否 / No | 5 | 返回结果数量（1-20） / Number of results to return (1-20) |
+| type | string | 否 / No | web | 搜索类型：web（网页）或 news（新闻） / Search type: web (webpage) or news (news articles) |
 
-**响应示例：**
+**响应示例：** / **Response Example:**
 
 ```json
 {
@@ -195,13 +184,14 @@ GET /search
 }
 ```
 
-### 工具定义接口
+### 工具定义接口 / Tool Definition Endpoint
 
 ```
 GET /tool-definition
 ```
 
 返回兼容 OpenAI 工具格式的 JSON 定义：
+Returns JSON definition compatible with OpenAI tool format:
 
 ```json
 {
@@ -234,21 +224,21 @@ GET /tool-definition
 }
 ```
 
-### 搜索建议接口
+### 搜索建议接口 / Search Suggestions Endpoint
 
 ```
 GET /suggest?query=部分关键词
 ```
 
-### 健康检查接口
+### 健康检查接口 / Health Check Endpoint
 
 ```
 GET /health
 ```
 
-## 使用示例
+## 使用示例 / Usage Examples
 
-### Python AI 助手集成
+### Python AI 助手集成 / Python AI Assistant Integration
 
 ```python
 import requests
@@ -260,12 +250,12 @@ def web_search(query, limit=5):
     )
     return response.json()
 
-# 使用示例
+# 使用示例 / Usage example
 results = web_search("最新的AI技术")
 print(results)
 ```
 
-### JavaScript AI 助手集成
+### JavaScript AI 助手集成 / JavaScript AI Assistant Integration
 
 ```javascript
 async function webSearch(query, limit = 5) {
@@ -275,108 +265,94 @@ async function webSearch(query, limit = 5) {
   return await response.json();
 }
 
-// 使用示例
+// 使用示例 / Usage example
 const results = await webSearch("机器学习最新进展");
 console.log(results);
 ```
 
-## 故障排除
+## 故障排除 / Troubleshooting
 
-### 1. 端口被占用
+### 1. 端口被占用 / Port already in use
 
 ```bash
-# 使用其他端口
+# 使用其他端口 / Use a different port
 ai-web-search -p 8080
 ```
 
-### 2. 搜索无结果
-
-- 检查网络连接
-- 尝试不同的搜索关键词
-- 查看服务器日志
-
-### 3. 连接被拒绝
+### 2. 搜索无结果 / No search results
 
-- 确认服务器正在运行
-- 检查防火墙设置
-- 验证端口是否正确
+- 检查网络连接 / Check network connection
+- 尝试不同的搜索关键词 / Try different search keywords
+- 查看服务器日志 / Check server logs
 
-### 4. Git克隆失败
+### 3. 连接被拒绝 / Connection refused
 
-```bash
-# 如果git clone失败，检查网络连接
-git config --global http.proxy  # 设置代理（如果需要）
+- 确认服务器正在运行 / Confirm server is running
+- 检查防火墙设置 / Check firewall settings
+- 验证端口是否正确 / Verify port is correct
 
-# 或者使用SSH方式（需要配置SSH密钥）
-git clone git@github.com:your-username/ai-web-search.git
 
-# 如果证书问题，可以临时跳过SSL验证（不推荐）
-git -c http.sslVerify=false clone https://github.com/your-username/ai-web-search.git
-```
 
-### 5. npm install失败
+### 5. npm install失败 / npm install failed
 
 ```bash
-# 清除npm缓存
+# 清除npm缓存 / Clear npm cache
 npm cache clean --force
 
-# 使用淘宝镜像（国内加速）
+# 使用淘宝镜像（国内加速）/ Use Taobao mirror (China acceleration)
 npm install --registry=https://registry.npmmirror.com
 
-# 检查Node.js版本
-node --version  # 需要 >= 14.0.0
+# 检查Node.js版本 / Check Node.js version
+node --version  # 需要 >= 14.0.0 / Requires >= 14.0.0
 ```
 
-## 开发
+## 开发 / Development
 
-### 本地开发
+### 本地开发 / Local Development
 
 ```bash
-# 克隆项目
-git clone https://github.com/your-username/ai-web-search.git
-cd ai-web-search
-
-# 安装依赖
+# 安装依赖 / Install dependencies
 npm install
 
-# 开发模式运行
+# 开发模式运行 / Run in development mode
 npm run dev
 
-# 运行测试
+# 运行测试 / Run tests
 npm test
 ```
 
-### 项目结构
+### 项目结构 / Project Structure
 
 ```
 ai-web-search/
 ├── bin/
-│   └── cli.js           # 命令行入口
+│   └── cli.js           # 命令行入口 / Command line entry
 ├── src/
-│   ├── index.js         # 主入口
-│   ├── server.js        # HTTP服务器
-│   └── search.js        # 搜索引擎模块
+│   ├── index.js         # 主入口 / Main entry
+│   ├── server.js        # HTTP服务器 / HTTP server
+│   └── search.js        # 搜索引擎模块 / Search engine module
 ├── examples/
-│   ├── custom-search.js # 自定义搜索引擎示例
-│   └── baidu-search.js  # 百度搜索引擎实现
+│   ├── custom-search.js # 自定义搜索引擎示例 / Custom search engine example
+│   └── baidu-search.js  # 百度搜索引擎实现 / Baidu search engine implementation
 ├── test/
-│   ├── test.js          # 测试文件
-│   └── test-custom.js   # 自定义搜索测试
+│   ├── test.js          # 测试文件 / Test file
+│   └── test-custom.js   # 自定义搜索测试 / Custom search test
 ├── package.json
 ├── README.md
 ├── .gitignore
 └── .env.example
 ```
 
-## 许可证
+## 许可证 / License
 
 MIT License
 
-## 贡献
+## 贡献 / Contributing
 
 欢迎提交 Issue 和 Pull Request！
+Issues and Pull Requests are welcome!
 
-## 相关项目
+## 相关项目 / Related Projects
 
-- [duck-duck-scrape](https://github.com/Snazzah/duck-duck-scrape) - DuckDuckGo 搜索库
-- [Express](https://expressjs.com/) - Web 框架
+- [duck-duck-scrape](https://github.com/Snazzah/duck-duck-scrape) - DuckDuckGo 搜索库 / DuckDuckGo search library
+- [Express](https://expressjs.com/) - Web 框架 / Web framework

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai-web-search",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A lightweight tool that enables AI assistants to search the internet via local HTTP server",
   "main": "src/index.js",
   "type": "commonjs",