Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
versun committed Sep 27, 2023
1 parent f56e1de commit 49558bb
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 4 deletions.
2 changes: 2 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
github: versun
custom: ["https://afdian.net/a/versun"]
33 changes: 29 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,30 @@
# RSS Translator
[RssTranslator.com](https://rsstranslator.com/)\
Translates an RSS feed into a new RSS feed in a different language.
# [RSS翻译器](https://www.rsstranslator.com/)
[EN](README_EN.md) / [中文](README.md)

For now, only the title will be translated.
RSS 翻译器历时 3 个月,总算开始内测了。\
网站: https://www.rsstranslator.com \
开发的主要原因是解决个人需求,关注了很多国外的博主,但英文标题不利于快速筛选,因此做了 RSS翻译器。

### 技术栈:
前端: 无框架,纯手工打造(HTML+JS+CSS)\
后端: Python\
前端部署在 Cloudflare 的 Pages\
后端和数据库部署在 Appwrite\
翻译引擎: GPT-3.5 / 被过滤的内容将用 DeepL 翻译

### 使用方法:
打开[RSS翻译器](https://www.rsstranslator.com/),输入 feed 源地址,选择目标语言,点击 Create 即可

### 注意事项:
1.仅翻译标题\
2.免费,如果对您有帮助,欢迎[赞助](https://github.com/sponsors/versun)以维持免费状态\
3.较大的 feed 源会花费较长的时间进行翻译(5 分钟左右)(仅翻译前 1000 个标题)\
4.所有 feed 每 20 分钟自动更新一次\
5.在网页端重新输入同一个 feed 源将会强制更新一次

目前还是内测阶段,欢迎提 Bug\
论坛:https://feedback.rsstranslator.com/ \
Telegram: https://t.me/rsstranslator

### 关于这个仓库
这个仓库仅用于展示和Issue跟踪,只有前端页面代码是开源的,并不包含后端代码。
30 changes: 30 additions & 0 deletions README_EN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# [RSS Translator](https://www.rsstranslator.com/)
[EN](README_EN.md) / [中文](README.md)

RSS Translator is finally in beta after 3 months. \
Website: https://www.rsstranslator.com \
The main reason for the development is to solve personal needs, follow a lot of foreign bloggers, but the English title is not conducive to rapid screening, so I made RSS translator.

### Technology stack:
Front-end: No framework, purely hand-built (HTML+JS+CSS)\
Backend: Python\
Front-end deployed in Cloudflare's Pages\
Backend and database deployed in Appwrite\
Translation engine: GPT-3.5 / Filtered content will be translated using DeepL

### How to use:
Open [RSS Translator](https://www.rsstranslator.com/), input the feed source address, select the target language, and click Create.

### Notes:
1.Only translate the headlines.\
2.Free of charge, if it is helpful to you, you are welcome to [Sponsor](https://github.com/sponsors/versun) to maintain the free status.\
3.Larger feeds will take longer to translate (around 5 minutes) (only the first 1000 headlines are translated) \
4.All feeds are automatically updated every 20 minutes.\
5.Re-entering the same feed on the web side will force it to update once.

It's still in beta, bugs are welcome!\
Forum: https://feedback.rsstranslator.com/ \
Telegram: https://t.me/rsstranslator

### About this repository
This repo is open source only for the RSS Translator front-end page code, and does not include the back-end code, which is only used for presentation and issue tracking!

0 comments on commit 49558bb

Please sign in to comment.