Merge pull request #84 from lcomplete/dev

Implement RSS feed detection and subscription functionality

Author: lcomplete

README.en.md

@@ -1,101 +1,96 @@
 # Huntly
 
-**中文** | [English](./README.en.md)
-
-## 目录
-
-- [Huntly](#huntly)
-  - [目录](#目录)
-  - [系统截图](#系统截图)
-  - [运行前提](#运行前提)
-  - [使用](#使用)
-    - [运行服务端](#运行服务端)
-      - [使用服务端安装包](#使用服务端安装包)
-      - [使用 docker 运行](#使用-docker-运行)
-      - [使用 Java 命令运行](#使用-java-命令运行)
-      - [安装为 windows 服务](#安装为-windows-服务)
-    - [安装浏览器插件](#安装浏览器插件)
-    - [浏览器插件设置](#浏览器插件设置)
-    - [启用 https](#启用-https)
-    - [登录并使用](#登录并使用)
-  - [请作者喝杯咖啡](#请作者喝杯咖啡)
-  - [感谢 JetBrains 的支持](#感谢-jetbrains-的支持)
-
-Huntly 是一个信息管理工具，它不仅可以自托管，也可以通过客户端在本地运行。它包含以下功能：
-
-- RSS 订阅。
-- 网页收藏，自动/手动保存浏览过的网页，随后以保存、稍后读、收藏或存档的方式将其保存。
-- 推文保存，针对推特网站有特殊的处理，会自动保存请求过的推特 timeline，记录是否浏览过，在 huntly 中你甚至可以用更方便的方式重新查看这些推文。
-- 内容全文搜索，可以从标题、内容、类型、收藏方式等维度进行搜索。
-- 连接 GitHub，支持 Github stars 管理。
-- **文本高亮功能，可对文章内容进行高亮标记，支持创建、删除和管理个人高亮内容(新功能)。**
-- **支持自定义文章 AI 快捷指令，具备双语对照翻译、总结、提取要点等能力(新功能)。**
-
-## 系统截图
+<div align="center">
+
+### ✨ Special Thanks To ✨
+
+<a href="https://www.augmentcode.com/">
+  <img src="static/images/sponsor/augment.png" alt="Augment Code" height="60" />
+</a>
+
+**[Augment Code](https://www.augmentcode.com/)** - Better Context. Better Agent. Better Code.
+
+---
+
+</div>
+
+**English** | [中文](./README.zh.md)
+
+Huntly is a self-hosted information management tool, in simple terms, contains the following features.
+
+- RSS subscription and reading.
+- Automatically saves the pages that have been viewed， then you can saves them as read later, favorites or archives.
+- There is a special treatment for Twitter sites that automatically saves the requested tweet timeline, recording whether it has been viewed or not, and in huntly you can even revisit these tweets in a more convenient way.
+- You can search by title, content, type, favorite method, and other dimensions.
+- Connect to GitHub, support Github stars management.
+- **Text highlighting feature, allows you to highlight article content, with support for creating, deleting and managing personal highlights (new feature).**
+- Support custom article AI shortcuts, with the ability to translate, summarize, extract key points, etc.
+
+## Screenshot
 
 ![intro1](static/images/intro1.png)
 
 ![intro2](static/images/intro2.png)
 
 ![extension_shortcuts](static/images/extension_shortcuts.png)
 
-## 运行前提
+## Requirements
 
 - Java 11
 
-## 使用
-
-### 运行服务端
+## Usage
 
-可以使用以下方式之一运行服务端。
+### Running the server side
+You can run the server using one of the following methods.
 
-#### 使用服务端安装包
+#### Using the Server Installation Package
 
-在 [Releases](https://github.com/lcomplete/huntly/releases) 中下载对应操作系统的安装包，安装后运行即可。
+Download the installation package for your corresponding operating system from [Releases](https://github.com/lcomplete/huntly/releases), and run it after installation.
 
-在 Mac 中，如果碰到 `"Huntly.app" is damaged and can't be opened` 的提示消息，请先执行以下命令再进行安装。
+If you encounter the error message `"Huntly.app" is damaged and can't be opened`. while installing software on macOS, it may be due to security settings restrictions in macOS. To solve this problem, please try the following command in Terminal:
 
 ```sh
-sudo xattr -r -d com.apple.quarantine /YOUR_PATH/huntly.dmg
+sudo xattr -r -d com.apple.quarantine /YOUR_PATH/ChatGPT.app
 ```
 
-#### 使用 docker 运行
+#### Run with docker
 
 ```sh
 mkdir huntly && cd huntly
 docker run -itd --name huntly --restart=always -p <host port>:80 -v `pwd`/data:/data lcomplete/huntly
 ```
 
-总是拉取 latest 的镜像，如需要升级，可删除本地的 latest，然后再次运行启动命令即可。
+always pull the latest image. if you need to upgrade, you can delete the local latest image and run the startup command again.
+
 
-#### 使用 Java 命令运行
+#### Run with the Java command
 
-下载 [Releases](https://github.com/lcomplete/huntly/releases) 中的 jar 包，react 客户端也打包在其中。
+Download the jar package from [Releases](https://github.com/lcomplete/huntly/releases), in which the react client is also packaged.
 
-下载后在命令行中 cd 到当前目录，通过以下 Java 命令运行：
+After downloading, cd to the current directory from the command line and run it with the following Java command.
 
 ```sh
 java -Xms128m -Xmx1024m -jar huntly-server.jar
 ```
 
-默认以 8080 端口运行，你可以打开 [http://localhost:8080/](http://localhost:8080/) 端口进行访问，若需要使用其他端口，比如 80 端口，可运行以下命令：
+By default it runs on port 8080, you can open the [http://localhost:8080/](http://localhost:8080/) port for access, or if you need to use another port, such as port 80, you can run the following command.
 
 
 ```sh
 java -Xms128m -Xmx1024m -jar huntly-server.jar --server.port=80
 ```
 
-注意，Jar 包名称需要根据下载的包名做适当的修改。
+Note that the Jar package name needs to be modified appropriately according to the downloaded package name.
 
-#### 安装为 windows 服务
+#### Install as Windows Service
 
-新建 Huntly 目录，以下操作在该目录中进行。
+Create a new directory named Huntly, and perform the following operations in this directory.
 
-下载 [Releases](https://github.com/lcomplete/huntly/releases) 中的 jar 包。
+Download the jar package from [Releases](https://github.com/lcomplete/huntly/releases).
 
-下载 [WinSW exe](https://github.com/winsw/winsw/releases), 并将其重命名为 `app.exe` 。
+Download [WinSW exe](https://github.com/winsw/winsw/releases) and rename it to `app.exe`.
 
-新建 `app.xml`，内容如下：
+Create a new file named `app.xml` with the following content:
 
 ```xml
 <service>
@@ -108,58 +103,52 @@ java -Xms128m -Xmx1024m -jar huntly-server.jar --server.port=80
 </service>
 ```
 
-打开终端运行命令：
+After successful startup, you can access [http://localhost:8123](http://localhost:8123).
+
+Open the terminal and run the command:
 
 ```sh
 .\app.exe install .\app.xml
 ```
 
-执行完上面的命令后，Huntly 已经被安装为 windows 服务，并设置为开机自动启动。当前为未启动状态，使用以下命令启动服务：
+After executing the above command, Huntly has been installed as a Windows service and set to start automatically at boot. It is currently not started. Use the following command to start the service:
 
 ```sh
 .\app.exe start .\app.xml
 ```
 
-启动成功后可访问 [http://localhost:8123](http://localhost:8123) 。
-
-若提示 java 命令无法执行，可将 `executable` 的值改为完整的 `java.exe` 路径。
+If you receive an error message that java cannot be executed, change the value of `executable` to the full path of `java.exe`.
 
-还支持 uninstall、stop、restart、status、refresh、customize 等命令，具体使用方式请查看 [https://github.com/winsw/winsw](https://github.com/winsw/winsw)。
+Other commands such as uninstall, stop, restart, status, refresh, customize are also supported. For specific usage instructions please refer to [https://github.com/winsw/winsw](https://github.com/winsw/winsw).
 
-### 安装浏览器插件
+### Install the browser extension
 
-插件已上架 chrome 应用商店，可直接在 [chrome 应用商店 huntly 扩展页面](https://chrome.google.com/webstore/detail/huntly/cphlcmmpbdkadofgcedjgfblmiklbokm) 安装。
+The plugin has been uploaded to the Chrome Web Store and can be directly installed from the [Huntly extension page on the Chrome Web Store](https://chrome.google.com/webstore/detail/huntly/cphlcmmpbdkadofgcedjgfblmiklbokm).
 
-如果你想使用最新的功能，可下载 [Releases](https://github.com/lcomplete/huntly/releases) 中的 browser-extension.zip ，将其解压缩。
+If you want to use the latest features, you can download browser-extension.zip from [Releases](https://github.com/lcomplete/huntly/releases) and extract it.
 
-在浏览器中管理扩展，启用开发者模式，加载已解包的扩展即可。
+To manage extensions in your browser, enable developer mode and load the unpacked extension.
 
-### 浏览器插件设置
+### Browser extension settings
 
-点击插件图标，选择设置 huntly 的服务端地址（huntly 网站首页地址），对于远程地址，在正式使用时，强烈建议使用 https 协议，毕竟浏览记录是相当私密的。若服务端在本机运行，则设置为本地地址即可。
+Click the huntly extension icon, choose to set huntly's server address (home page url), for the remote address, in formal use, it is highly recommended to use the https protocol, after all, the browsing history is quite private. If the server is running locally, then set it to the local address.
 
-### 启用 https
-
-可以申请免费的 https 证书，并增加以下配置（根据类型进行配置）：
-
-```sh
---server.ssl.key-store-type=JKS --server.ssl.key-store=<file.jks> --server.ssl.key-store-password=<password> --server.ssl.enabled=true
-```
+### Login and enjoy it
 
-### 登录并使用
+When you open huntly website for the first time, you will be prompted to register an administrator user, currently only single user is supported.
 
-首次打开 huntly 网站时，会提示注册一个管理员用户，目前仅支持单用户。
+After registration, you will be automatically logged into the system, and the huntly extension will only send browsing history to the server if you are logged in.
 
-注册后将自动登录到系统中，在登录的情况下，huntly 插件才能将浏览记录发送到服务端。
+Enjoy it.
 
-## 请作者喝杯咖啡
+## Buy me a coffee
 
 <p align="center">
 	<img height="360" src="static/images/wechat.JPG" />
 	<img height="360" src="static/images/zfb.JPG" />
 </p>
 
-## 感谢 JetBrains 的支持
+## Thanks to JetBrains support
 
 <a href="https://www.jetbrains.com/?from=huntly">
   <img src="static/images/jb_beam.png" height="200" />