Skip to content

Commit

Permalink
Merge pull request #45 from kenshinji/chore/update-doc
Browse files Browse the repository at this point in the history
chore: Update doc.
  • Loading branch information
kenshinji authored Oct 30, 2024
2 parents 7748418 + b851822 commit 4377951
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,31 @@
"color":"<自定义显示颜色>" //自定义字体颜色显示,默认白色
}

## 功能特点
- 支持英文查中文
- 支持中文查英文
- 支持发音标注
- 支持网络释义
- 支持自定义代理和颜色设置

## 命令行选项
yd -h, --help 显示帮助信息
yd -v, --version 显示版本号
yd <word> 查询单词或短语

## 系统要求
- Node.js >= 12.0.0
- npm >= 6.0.0

## 常见问题
如果安装或使用过程中遇到问题,请确保:
1. Node.js 版本符合要求
2. 使用 `npm install -g yddict` 进行全局安装
3. 如果在公司网络环境下使用,请正确配置代理设置

## 开源协议
MIT License

## 如何贡献代码
1.[fork](https://www.zhihu.com/question/20431718)这个代码库。
2. `npm install` 安装所需要的依赖。
Expand Down

0 comments on commit 4377951

Please sign in to comment.