Skip to content

Commit 08855cf

Browse files
libyliby
committed
docs: update README.md
1 parent eae636e commit 08855cf

File tree

3 files changed

+108
-84
lines changed

3 files changed

+108
-84
lines changed

‎README-CN.md‎

Lines changed: 0 additions & 63 deletions
This file was deleted.

‎README.md‎

Lines changed: 33 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<h4 align="right">
2+
<strong>简体中文</strong> | <a href="https://github.com/yetone/bob-plugin-openai-translator/blob/main/docs/README_EN.md">English</a>
3+
</h4>
4+
15
<div>
26
<h1 align="center">OpenAI Translator Bob Plugin</h1>
37
<p align="center">
@@ -16,46 +20,54 @@
1620
</p>
1721
</div>
1822

19-
Important update: Non-macOS users can use my browser extension based on ChatGPT API for word translation [openai-translator](https://github.com/yetone/openai-translator) to solve urgent needs.
23+
> **Note**
24+
>
25+
> 重要更新：非 macOS 用户可以使用我开发的基于 ChatGPT API 的划词翻译浏览器插件 [openai-translator](https://github.com/yetone/openai-translator) 以解燃眉之急。
2026
21-
# Screenshots
27+
## 演示
2228

2329
![](https://user-images.githubusercontent.com/1206493/221086195-f1ed941d-4dfa-4aa0-9d47-56c258a8f854.gif)
2430

25-
# Introduction
31+
## 简介
32+
33+
ChatGPT 向我们展示了 GPT 模型的伟大之处，所以我使用 OpenAI 的 API 实现了这个 Bob 的翻译 + 润色 + 语法修改插件，效果拔群！
2634

27-
ChatGPT showed us the greatness of the GPT model, so I developed this Bob translation + polishing + grammar correction plugin using OpenAI's API, which has excellent results!
35+
### 润色功能
2836

29-
This plugin now supports using the ChatGPT API to refine and modify sentences for grammar. Simply select the target language to be the same as the source language, making it a comprehensive replacement for Grammarly! Moreover, theoretically any language can be refined, not just English.
37+
此插件已支持使用 ChatGPT API 对句子进行润色和语法修改，只需要把目标语言设置为与源语言一样即可，全面替代 Grammarly！而且理论上任何语言都可以润色，不仅仅是英语。
3038

31-
If you don't like the translation and text polishing being put together, here is a separate plugin specifically for text polishing and grammar correction: [bob-plugin-openai-polisher](https://github.com/yetone/bob-plugin-openai-polisher). This polishing plugin has more advanced polishing functions, such as explaining modification reasons.
39+
如果你不喜欢将翻译功能和文本润色功能放在一起，这里单独拆分出了一个专门用来文本润色和语法纠错的插件: [bob-plugin-openai-polisher](https://github.com/yetone/bob-plugin-openai-polisher)，这个润色插件具有更高级的润色功能，比如解释修改原因等。
3240

33-
To use the ChatGPT API, you need to change the model of this plugin to `gpt-3.5-turbo-0301` or `gpt-3.5-turbo` on Bob's settings page:
41+
### 语言模型
42+
43+
要使用 ChatGPT 的 API 需要在 Bob 的设置页面把此插件的模型改为 `gpt-3.5-turbo-0301` 或者 `gpt-3.5-turbo`:
3444

3545
![how to use ChatGPT API](https://user-images.githubusercontent.com/1206493/222339607-d8f05042-4b65-495c-af58-849891de7434.png)
3646

37-
This is just a small Bob plugin, the real power lies within Bob itself. Let's pay tribute to its developer [ripperhe](https://github.com/ripperhe)!
47+
## 使用方法
48+
49+
1. 安装 [Bob](https://bobtranslate.com/guide/#%E5%AE%89%E8%A3%85) (版本 >= 0.50)，一款 macOS 平台的翻译和 OCR 软件
3850

39-
# Usage
51+
2. 下载此插件: [openai-translator.bobplugin](https://github.com/yetone/bob-plugin-openai-translator/releases/latest)
4052

41-
1. Install [Bob](https://bobtranslate.com/guide/#%E5%AE%89%E8%A3%85) (version >= 0.50)
42-
2. Download this plugin: [openai-translator.bobplugin](https://github.com/yetone/bob-plugin-openai-translator/releases)
43-
3. Install this plugin:
53+
3. 安装此插件:
54+
![安装步骤](https://user-images.githubusercontent.com/1206493/219937302-6be8d362-1520-4906-b8d6-284d01012837.gif)
4455

45-
![](https://user-images.githubusercontent.com/1206493/219937302-6be8d362-1520-4906-b8d6-284d01012837.gif)
56+
4. 去 [OpenAI](https://platform.openai.com/account/api-keys) 获取你的 API KEY
4657

47-
4. Go to [OpenAI](https://platform.openai.com/account/api-keys) to get your API KEY
48-
5. Fill in the API KEY in the configuration interface of Bob plugin
58+
5. 把 API KEY 填入 Bob 偏好设置 > 服务 > 此插件配置界面的 API KEY 的输入框中
59+
![设置步骤](https://user-images.githubusercontent.com/1206493/219937398-8e5bb8d2-7dc8-404a-96e7-a937e08c939f.gif)
4960

50-
![](https://user-images.githubusercontent.com/1206493/219937398-8e5bb8d2-7dc8-404a-96e7-a937e08c939f.gif)
61+
6. 安装 [PopClip](https://bobtranslate.com/guide/integration/popclip.html) 实现划词后鼠标附近出现悬浮图标
62+
![PopClip](https://user-images.githubusercontent.com/1206493/219933584-d0c2b6cf-8fa0-40a6-858f-8f4bf05f38ef.gif)
5163

52-
6. Install [PopClip](https://bobtranslate.com/guide/integration/popclip.html) to display a small icon near the mouse after selecting text
64+
## 感谢
5365

54-
![](https://user-images.githubusercontent.com/1206493/219933584-d0c2b6cf-8fa0-40a6-858f-8f4bf05f38ef.gif)
66+
我这只是个小小的 Bob 插件，强大的是 Bob 本身，向它的开发者 [ripperhe](https://github.com/ripperhe) 致敬！
5567

56-
# Buy me a coffee
68+
### 请作者喝一杯咖啡
5769

5870
<div align="center">
59-
<img height="360" src="https://user-images.githubusercontent.com/1206493/220753437-90e4039c-d95f-4b6a-9a08-b3d6de13211f.png" />
60-
<img height="360" src="https://user-images.githubusercontent.com/1206493/220756036-d9ac4512-0375-4a32-8c2e-8697021058a2.png" />
71+
<img height="360" src="https://user-images.githubusercontent.com/1206493/220753437-90e4039c-d95f-4b6a-9a08-b3d6de13211f.png" />
72+
<img height="360" src="https://user-images.githubusercontent.com/1206493/220756036-d9ac4512-0375-4a32-8c2e-8697021058a2.png" />
6173
</div>

‎docs/README_EN.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<h4 align="right">
2+
<a href="https://github.com/yetone/bob-plugin-openai-translator/blob/main/README.md">简体中文</a> | <strong>English</strong>
3+
</h4>
4+
5+
<div>
6+
<h1 align="center">OpenAI Translator Bob Plugin</h1>
7+
<p align="center">
8+
<a href="https://github.com/yetone/bob-plugin-openai-translator/releases" target="_blank">
9+
<img src="https://github.com/yetone/bob-plugin-openai-translator/actions/workflows/release.yaml/badge.svg" alt="release">
10+
</a>
11+
<a href="https://github.com/yetone/bob-plugin-openai-translator/releases">
12+
<img alt="GitHub Repo stars" src="https://img.shields.io/github/Stars/yetone/bob-plugin-openai-translator?style=flat">
13+
</a>
14+
<a href="https://github.com/yetone/bob-plugin-openai-translator/releases">
15+
<img alt="GitHub Repo stars" src="https://img.shields.io/badge/OpenAI-Bob-brightgreen?style=flat">
16+
</a>
17+
<a href="https://github.com/yetone/bob-plugin-openai-translator/releases">
18+
<img alt="GitHub Repo stars" src="https://img.shields.io/badge/Langurage-JavaScript-brightgreen?style=flat&color=blue">
19+
</a>
20+
</p>
21+
</div>
22+
23+
> **Note**
24+
>
25+
> Important update: Non-macOS users can use my browser extension based on ChatGPT API for word translation [openai-translator](https://github.com/yetone/openai-translator) to solve urgent needs.
26+
27+
28+
## Demonstration
29+
30+
![demo](https://user-images.githubusercontent.com/1206493/221086195-f1ed941d-4dfa-4aa0-9d47-56c258a8f854.gif)
31+
32+
"""
33+
## Introduction
34+
35+
ChatGPT showcases the greatness of GPT models, so I have implemented the Bob translation + polishing + grammar modification plugin using OpenAI's API, with outstanding results!
36+
37+
### Polishing Feature
38+
39+
This plugin supports polishing sentences and modifying grammar using the ChatGPT API. To do so, just set the target language to be the same as the source language. It's a comprehensive alternative to Grammarly! And in theory, any language can be polished, not just English.
40+
41+
If you don't like combining translation functionality and text polishing, a separate plugin specifically for text polishing and grammar correction is available: [bob-plugin-openai-polisher](https://github.com/yetone/bob-plugin-openai-polisher). This polishing plugin has more advanced polishing features, such as explaining the modification reasons, etc.
42+
43+
### Language Model
44+
45+
To use the ChatGPT API, go to Bob's settings page and change the plugin model to `gpt-3.5-turbo-0301` or `gpt-3.5-turbo`:
46+
47+
![how to use ChatGPT API](https://user-images.githubusercontent.com/1206493/222339607-d8f05042-4b65-495c-af58-849891de7434.png)
48+
49+
## Usage
50+
51+
1. Install [Bob](https://bobtranslate.com/guide/#%E5%AE%89%E8%A3%85) (version >= 0.50), a macOS translation and OCR software
52+
53+
2. Download this plugin: [openai-translator.bobplugin](https://github.com/yetone/bob-plugin-openai-translator/releases/latest)
54+
55+
3. Install this plugin:
56+
![Installation Steps](https://user-images.githubusercontent.com/1206493/219937302-6be8d362-1520-4906-b8d6-284d01012837.gif)
57+
58+
4. Get your API KEY from [OpenAI](https://platform.openai.com/account/api-keys)
59+
60+
5. Enter the API KEY in Bob Preferences > Services > This plugin configuration interface's API KEY input box:
61+
![Settings Steps](https://user-images.githubusercontent.com/1206493/219937398-8e5bb8d2-7dc8-404a-96e7-a937e08c939f.gif)
62+
63+
6. Install [PopClip](https://bobtranslate.com/guide/integration/popclip.html) for highlighted text mouse proximity floating icon:
64+
![PopClip](https://user-images.githubusercontent.com/1206493/219933584-d0c2b6cf-8fa0-40a6-858f-8f4bf05f38ef.gif)
65+
66+
## Thanks
67+
68+
I'm just a small Bob plugin, and the powerful part is Bob itself. I pay tribute to its developer [ripperhe](https://github.com/ripperhe)!
69+
70+
### Buy me a coffee
71+
72+
<div align="center">
73+
<img height="360" src="https://user-images.githubusercontent.com/1206493/220753437-90e4039c-d95f-4b6a-9a08-b3d6de13211f.png" />
74+
<img height="360" src="https://user-images.githubusercontent.com/1206493/220756036-d9ac4512-0375-4a32-8c2e-8697021058a2.png" />
75+
</div>

0 commit comments

Comments
 (0)