|
| 1 | +# Fluent Read <img src="../public/icon/192.png" alt="Fluent Read" style="width:1em;" /> |
| 2 | + |
| 3 | +> Fluent Read, designed for a native-like reading experience. [Introduction video on Bilibili](https://www.bilibili.com/video/BV1ux4y1e73x). |
| 4 | +
|
| 5 | +[中文](https://github.com/Bistutu/FluentRead) | [English](https://github.com/Bistutu/FluentRead/misc/README_EN.md) |
| 6 | + |
| 7 | +Fluent Read is a highly efficient browser translation plugin that can translate text on web pages into any language. It is convenient, fast, and intuitive, and is powered by an artificial intelligence engine. |
| 8 | + |
| 9 | +Fluent Read is written using TypeScript + [Vue3](https://cn.vuejs.org/) + [Element-Plus](https://element-plus.org/) + [WXT](https://wxt.dev/) frameworks, and supports compilation into plugins installable on most browsers. |
| 10 | + |
| 11 | +<kbd><img src="../misc/sample-git-1.gif" alt="sample-git-1.gif" style="width: 80%; max-width: 100%;border: 1px solid black;"></kbd> |
| 12 | + |
| 13 | +<kbd><img src="../misc/screenshot-3.png" alt="sample-git-1.gif" style="width: 40%; max-width: 100%;border: 1px solid black;"></kbd> |
| 14 | + |
| 15 | +# Installation Guide |
| 16 | + |
| 17 | +> The plugin is available on major browser stores. You can install it directly using the following links: |
| 18 | +
|
| 19 | +- **Chrome Browser**: [Direct Install](https://chromewebstore.google.com/detail/FluentRead/djnlaiohfaaifbibleebjggkghlmcpcj?hl=zh-CN&authuser=0), [Alternative Link](https://www.crxsoso.com/webstore/detail/djnlaiohfaaifbibleebjggkghlmcpcj) |
| 20 | +- **Edge Browser**: [Direct Install](https://microsoftedge.microsoft.com/addons/detail/FluentRead/kakgmllfpjldjhcnkghpplmlbnmcoflp?hl=zh-CN), [Alternative Link](https://www.crxsoso.com/webstore/detail/djnlaiohfaaifbibleebjggkghlmcpcj) |
| 21 | +- **Firefox Browser**: [Direct Install](https://addons.mozilla.org/zh-CN/firefox/addon/%E6%B5%81%E7%95%85%E9%98%85%E8%AF%BB/?utm_source=addons.mozilla.org&utm_medium=referral&utm_content=search), [Alternative Link](https://www.crxsoso.com/firefox/detail/流畅阅读) |
| 22 | +- **Other Browsers**: [Alternative Link](https://www.crxsoso.com/webstore/detail/djnlaiohfaaifbibleebjggkghlmcpcj) |
| 23 | + |
| 24 | +If direct installation fails, you can download the plugin's ZIP file, open your browser's **Manage Extensions Window**, activate developer mode, and drag the ZIP file into the browser for installation. |
| 25 | + |
| 26 | +<img src="../misc/screenshot-1.png" alt="sample-git-1.gif" style="width: 45%; max-width: 100%;border: 1px solid black;"><img src="../misc/screenshot-2.png" alt="sample-git-2.gif" style="width: 45%; max-width: 100%;border: 1px solid black;"> |
| 27 | + |
| 28 | +# Features |
| 29 | + |
| 30 | +1. Multiple translation methods: |
| 31 | + - Key shortcut translation: Hover the mouse over the text and press the designated shortcut key to translate. |
| 32 | + - Slide translation: Hold down the shortcut key and slide the mouse to select the text area you want to translate. |
| 33 | + |
| 34 | +2. Supports caching and back translation: |
| 35 | + - To avoid re-translating sentences and reduce request counts, Fluent Read caches translations on each page. You don't need to worry about the details (blue indicates normal translation, green indicates cached translation). When using cached translations, no network request occurs. |
| 36 | + |
| 37 | + <kbd><img src="../misc/sample-git-3.gif" alt="sample-git-1.gif" style="width: 80%; max-width: 100%;border: 1px solid black;"></kbd> |
| 38 | + |
| 39 | + - Hovering the mouse over translated text and pressing the shortcut key triggers the **back translation feature**. |
| 40 | + |
| 41 | + <kbd><img src="../misc/sample-git-2.gif" alt="sample-git-1.gif" style="width: 70%; max-width: 100%;border: 1px solid black;"></kbd> |
| 42 | + |
| 43 | +# FAQ |
| 44 | + |
| 45 | +<details> |
| 46 | + <summary>1. How do I obtain a token?</summary> |
| 47 | + If you want to get a token for translation services, it's recommended to search on Baidu or Google with keywords like <code>model name + API</code>. |
| 48 | +</details> |
| 49 | +<details> |
| 50 | + <summary>2. Can someone steal my token?</summary> |
| 51 | + No. Fluent Read stores all your tokens locally in the browser, so no third party, including us, can steal your token data. |
| 52 | +</details> |
| 53 | +<details> |
| 54 | + <summary>3. Can my data be intercepted by others?</summary> |
| 55 | + No. Fluent Read does not collect your data. All your translation requests are directly forwarded to the translation service provider, so no intermediary can access your translation records. |
| 56 | +</details> |
| 57 | +<details> |
| 58 | + <summary>4. Why might the translation be inaccurate?</summary> |
| 59 | + There are many reasons why translations might be inaccurate. First, the translation engine might not fully understand the context and subtle language nuances of the original text. Secondly, different languages have different grammatical structures and expressions, which can make it difficult to retain the full meaning of the original text when translated directly. <strong>It is suggested to try other models.</strong> |
| 60 | +</details> |
| 61 | + |
| 62 | +# Version History |
| 63 | + |
| 64 | +- 2024-04-01: Program restructured using Vue3 + WXT, released version 0.01. |
| 65 | +- 2024-03-04: Version update 1.30 |
| 66 | + 1. Added [DeepL](https://deepl.com/zh/) translation service. |
| 67 | + 1. Added [ollama](https://github.com/ollama/ollama) local large model support. |
| 68 | + 1. Made compatible with mobile devices, implementing "three-finger touch" translation. |
| 69 | + 1. Optimized caching logic. |
| 70 | + |
| 71 | +- 2024-02-18: Version 1.0 released. |
| 72 | + 1. Integrated Microsoft machine translation. |
| 73 | + 2. Integrated OpenAI, Zhipu Qingyan, moonshot, and other AI engines. |
| 74 | + 3. Added shortcut key translation feature. |
| 75 | + 4. Added translation caching and back translation feature. |
| 76 | +- 2024-01: Version 0.6 released. |
| 77 | +- ... |
| 78 | +- 2023-12: Version 0.1 released. |
| 79 | + |
| 80 | +# Open Source License |
| 81 | + |
| 82 | +[GPL-3.0 license](https://github.com/Bistutu/FluentRead#) |
| 83 | + |
| 84 | +# How to Run the Program? |
| 85 | + |
| 86 | +```shell |
| 87 | +git clone https://github.com/Bistutu/FluentRead.git |
| 88 | +cd ./FluentRead |
| 89 | +pnpm install && pnpm dev |
| 90 | +``` |
| 91 | + |
| 92 | +```shell |
| 93 | +# Package for Chromium-based browsers |
| 94 | +pnpm zip |
| 95 | +# Package for Firefox-based browsers |
| 96 | +pnpm zip:firefox |
| 97 | +``` |
| 98 | + |
| 99 | +# Star History Chart |
| 100 | + |
| 101 | +[](https://star-history.com/#Bistutu/FluentRead&Date) |
| 102 | + |
| 103 | +# Appreciation Code |
| 104 | + |
| 105 | +If you wish to encourage the author, please use WeChat to scan the QR code below, and your name will appear on the list of sponsors. |
| 106 | + |
| 107 | +<img src="../misc/approve.jpg" alt="wechat" style="width: 35%; max-width: 100%;border: 1px solid black;"> |
| 108 | + |
| 109 | +| No. | 🌼Sponsor🌼 | Amount Sponsored | |
| 110 | +| :--: | :------------------------------------: | :--------------: | |
| 111 | +| 1 | TOO | 100 | |
| 112 | +| 2 | Cool Little Boss | 57 | |
| 113 | +| 3 | coonut🥥 | 36 | |
| 114 | +| 4 | Lazy Mountain. | 18 | |
| 115 | +| 5 | Glutton | 17 | |
| 116 | +| 6 | They say the sea swallows fish's tears | 17 | |
| 117 | +| 7 | Tang Qing | 6.6 | |
| 118 | +| 8 | Sincerely not half a poundぴ | 5 | |
| 119 | +| 9 | … | … | |
0 commit comments