Skip to content

Commit

Permalink
doc: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
zhangxunwei committed Oct 22, 2024
1 parent 26fc95a commit eece298
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 11 deletions.
10 changes: 6 additions & 4 deletions README-zh.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# 百词斩助手
# 百词斩助手
中文 | [English](./README.md)

本应用是类似于谷歌翻译插件的一款浏览器插件,其支持划词翻译,并且可以与百词斩 APP 协同操作。当前支持的功能如下:
- 划词翻译
- 收藏/取消收藏单词(并实时同步到百词斩 APP 中)
- 搜索单词,显示详情信息
- 查看单词本中的单词
- 背单词
- ...

## 如何使用
Expand All @@ -16,6 +17,10 @@
## 安装
[![https://chrome.google.com/webstore/detail/%E7%99%BE%E8%AF%8D%E6%96%A9%E5%8A%A9%E6%89%8B/ofdejofffdjcmlbclhhfeaefodgffbnm](./images/tryitnow.png)](https://chrome.google.com/webstore/detail/%E7%99%BE%E8%AF%8D%E6%96%A9%E5%8A%A9%E6%89%8B/ofdejofffdjcmlbclhhfeaefodgffbnm)

<a href="https://microsoftedge.microsoft.com/addons/detail/%E6%96%B0%E7%99%BE%E8%AF%8D%E6%96%A9%E5%8A%A9%E6%89%8B/igoongmgkfmdmlnabfphphifbmckjjea">
<img src="./images/edge-logo.png" height="116"/>
</a>

或者下载最新[发行版本](https://github.com/marmot-z/baicizhan-helper/releases/latest)使用开发者模式安装

## 声明
Expand All @@ -24,9 +29,6 @@
## 相关项目
- [bing-translate-api-java](https://github.com/marmot-z/bing-translate-api-java)

## 赞助商
本项目由 [jetBrains](https://www.jetbrains.com/community/opensource/#support) 赞助。
<img src="./images/jb_beam.png" alt="sponsor" width="200"/>

## LICENSE
本项目基于 Apache-2 licence 开发
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ This application is a browser extension similar to the Google Translate plugin.
- Bookmarking/Unbookmarking words (with real-time synchronization to the Baicizhan APP)
- Word search and display of detailed information
- Viewing words in the wordbook
- memorize words (with real-time synchronization to the Baicizhan APP)
- ...

## How to Use
Expand All @@ -15,6 +16,9 @@ For relevant introductions and usage, please refer to the following two videos:

## Installation
[![https://chrome.google.com/webstore/detail/%E7%99%BE%E8%AF%8D%E6%96%A9%E5%8A%A9%E6%89%8B/ofdejofffdjcmlbclhhfeaefodgffbnm](./images/tryitnow.png)](https://chrome.google.com/webstore/detail/%E7%99%BE%E8%AF%8D%E6%96%A9%E5%8A%A9%E6%89%8B/ofdejofffdjcmlbclhhfeaefodgffbnm)
<a href="https://microsoftedge.microsoft.com/addons/detail/%E6%96%B0%E7%99%BE%E8%AF%8D%E6%96%A9%E5%8A%A9%E6%89%8B/igoongmgkfmdmlnabfphphifbmckjjea">
<img src="./images/edge-logo.png" height="116"/>
</a>

Alternatively, you can download the latest [release version](https://github.com/marmot-z/baicizhan-helper/releases/latest) and install it in developer mode.

Expand All @@ -24,10 +28,6 @@ This project is intended for personal practice. You are welcome to use this soft
## Related projects
- [bing-translate-api-java](https://github.com/marmot-z/bing-translate-api-java)

## Sponsor
This project is sponsored by [jetBrains](https://www.jetbrains.com/community/opensource/#support).
<img src="./images/jb_beam.png" alt="sponsor" width="200"/>

## LICENSE
This project is developed under the Apache-2 license.

Expand Down
Binary file added images/edge-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/memorize-words.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 7 additions & 3 deletions src/usage.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,6 @@ <h4>百词斩助手使用手册</h4>
<li>形近词</li>
<li>英文释义</li>
</ul>
<p>
4,代理服务器,不用修改
</p>
<br>
<br>

Expand Down Expand Up @@ -92,5 +89,12 @@ <h4>百词斩助手使用手册</h4>
勾中「隐藏释义」、「隐藏英文」选项,可以隐藏单词释义和原文。
</p>
<img src="../images/manage-wordbook.gif" style="height: 400px;" />

<p><strong>背单词</strong></p>
<p>
进入选项页面,打开「背单词」选项并保存。点击「去背单词」按钮进入学习页面。
可以选择学习新单词或者复习今日已学单词,学习完毕后会将记录同步到百词斩 APP 中。
</p>
<img src="../images/memorize-words.gif" style="height: 400px;" />
</body>
</html>

0 comments on commit eece298

Please sign in to comment.