docs: update README

This commit is contained in:
DIYgod 2023-08-20 23:48:51 +01:00
parent bc98ba2aff
commit d0aed025a5
No known key found for this signature in database
1 changed files with 11 additions and 46 deletions

View File

@ -6,9 +6,6 @@
> RSSHub Radar for [RSSHub](https://github.com/DIYgod/RSSHub), a browser extension that helps you quickly discover and subscribe to RSS and RSSHub feeds from the current website.
> Everything is RSSible
> RSSHub Radar 是 [RSSHub](https://github.com/DIYgod/RSSHub) 的衍生项目,她是一个可以帮助你快速发现和订阅当前网站 RSS 和 RSSHub 的浏览器扩展
> 万物皆可 RSS
[![version](https://img.shields.io/chrome-web-store/v/kefjpfngnndepjbopdmoebkipbgkggaa.svg?style=flat-square)](https://chrome.google.com/webstore/detail/kefjpfngnndepjbopdmoebkipbgkggaa)
[![users](https://img.shields.io/chrome-web-store/users/kefjpfngnndepjbopdmoebkipbgkggaa.svg?style=flat-square)](https://chrome.google.com/webstore/detail/kefjpfngnndepjbopdmoebkipbgkggaa)
[![rating](https://img.shields.io/chrome-web-store/rating/kefjpfngnndepjbopdmoebkipbgkggaa.svg?style=flat-square)](https://chrome.google.com/webstore/detail/kefjpfngnndepjbopdmoebkipbgkggaa)
@ -22,9 +19,9 @@
<a href="https://addons.mozilla.org/zh-CN/firefox/addon/rsshub-radar/"><img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_128x128.png" width="48" /></a>
<a href="https://apps.apple.com/us/app/rsshub-radar/id1610744717?l=zh&mt=12"><img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_128x128.png" width="48" /></a>
## Introduction 介绍
## Introduction
[Telegram group](https://t.me/rsshub) | [Telegram channel频道](https://t.me/awesomeRSSHub)
[Telegram group](https://t.me/rsshub) | [Telegram channel](https://t.me/awesomeRSSHub)
RSSHub Radar is a spin-off project of [RSSHub](https://github.com/DIYgod/RSSHub), a browser extension that helps you quickly discover and subscribe to current website RSS and RSSHub
@ -33,27 +30,20 @@ RSSHub Radar is a spin-off project of [RSSHub](https://github.com/DIYgod/RSSHub)
- Quickly discover the RSSHub supported by the current website
- Supports one-click subscription RSS to Tiny Tiny RSS, Miniflux, FreshRSS, Nextcloud News, Feedly, Inoreader, Feedbin, The Old Reader, Feeds.Pub, BazQux Reader, Local Reader
RSSHub Radar 是 [RSSHub](https://github.com/DIYgod/RSSHub) 的衍生项目,她是一个可以帮助你快速发现和订阅当前网站 RSS 和 RSSHub 的浏览器扩展
- 快速发现和订阅当前页面自带的 RSS
- 快速发现和订阅当前页面支持的 RSSHub
- 快速发现当前网站支持的 RSSHub
- 支持一键订阅 RSS 到 Tiny Tiny RSS、Miniflux、FreshRSS、Nextcloud News、Feedly、Inoreader、Feedbin、The Old Reader、Feeds.Pub、BazQux Reader、本地阅读器
![](https://i.imgur.com/K1cC5Ck.png)
![](https://i.imgur.com/JbLseIa.png)
## Install安装
## Install
### Webstore商店安装
### Webstore
<a href="https://chrome.google.com/webstore/detail/kefjpfngnndepjbopdmoebkipbgkggaa"><img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_128x128.png" width="48" /></a>
<a href="https://microsoftedge.microsoft.com/addons/detail/gangkeiaobmjcjokiofpkfpcobpbmnln"><img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_128x128.png" width="48" /></a>
<a href="https://addons.mozilla.org/zh-CN/firefox/addon/rsshub-radar/"><img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_128x128.png" width="48" /></a>
<a href="https://apps.apple.com/us/app/rsshub-radar/id1610744717?l=zh&mt=12"><img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_128x128.png" width="48" /></a>
### Manual installation手动安装
### Manual installation
First download the corresponding version of `radar.zip` from the [releases](https://github.com/DIYgod/RSSHub-Radar/releases) page and unzip it
@ -75,35 +65,11 @@ Click `Load Temporary Extension` in the upper right corner
Select the `manifest.json` file in the unzipped `dist` directory
---
## JOIN US
首先在 [release](https://github.com/DIYgod/RSSHub-Radar/releases) 页下载相应版本的 `radar.zip` 并解压
### Install the development version
**Chrome安装扩展**
打开 `chrome://extensions/`
打开右上角 `开发者模式`
点击左上角 `加载已解压的扩展程序`
选择解压出的 `dist` 目录
**Firefox安装扩展**
打开 `about:debugging`
点击右上角 `加载临时扩展程序`
选择解压出的 `dist` 目录中的 `manifest.json` 文件
---
## JOIN US参与我们
### Install the development version安装开发版本
**Install dependencies and build the project安装依赖并构建项目**
**Install dependencies and build the project:**
```
pnpm i
@ -118,13 +84,12 @@ npm run build
```
Get the dist directory, the installation method refers to [manual installation](#manual installation)
得到 dist 目录,安装方式参考 [手动安装](#手动安装)
### RSSHub Documentation - 补充 RSSHub 规则
### RSSHub Documentation
[See documentation见文档](https://docs.rsshub.app/joinus/quick-start.html#ti-jiao-xin-de-rsshub-gui-ze-tian-jia-jiao-ben-wen-dang)
[See documentation](https://docs.rsshub.app/joinus/quick-start.html#ti-jiao-xin-de-rsshub-gui-ze-tian-jia-jiao-ben-wen-dang)
## Related相关项目
## Related
- [RSSHub](https://github.com/DIYgod/RSSHub)