docs: update EN docs (#2364)

2025-12-09 06:30:40 +08:00 · 2019-06-11 04:12:01 +01:00
parent 490fc8056b
commit d787da7d6a
3 changed files with 99 additions and 63 deletions
--- a/docs/en/README.md
+++ b/docs/en/README.md
@@ -137,13 +137,13 @@ If no matching results were found, the server returns only a HTTP status code `2

 ### RSSHub

-### Update
+#### Update

 <RouteEn path="/rsshub/rss" example="/rsshub/rss" />

 ### MIUI

-### New firmware
+#### New firmware

 <RouteEn author="Indexyz" example="/miui/aries/" path="/miui/:device/:type?" :paramsDesc="['the device `codename` eg. `aries` for Mi 2S','type']" >

@@ -155,7 +155,7 @@ If no matching results were found, the server returns only a HTTP status code `2

 ### Firefox

-### New Release
+#### New Release

 <RouteEn author="fengkx" example="/firefox/release/desktop" path="/firefox/release/:platform" :paramsDesc="['the platform']" >

@@ -167,51 +167,51 @@ If no matching results were found, the server returns only a HTTP status code `2

 ### Thunderbird

-### Update
+#### Update

 <RouteEn author="garywill" path="/thunderbird/release" example="/thunderbird/release" />

 ### App Store/Mac App Store

-### App Update
+#### App Update

 <RouteEn author="cielpy" example="/appstore/update/us/id697846300" path="/appstore/update/:country/:id" :paramsDesc="['App Store Country, obtain from the app URL `https://itunes.apple.com/us/app/reeder-3/id697846300?mt=8`, in this case, `us`', 'App Store app id, obtain from the app URL `https://itunes.apple.com/us/app/reeder-3/id697846300?mt=8`, in this case, `id697846300`']" />

-### App Update
+#### Price Drop

 <RouteEn author="HenryQW" example="/appstore/price/us/mac/id1152443474" path="/appstore/price/:country/:type/:id" :paramsDesc="['App Store Country, obtain from the app URL https://itunes.apple.com/us/app/id1152443474, in this case, `us`', 'App type，either `iOS` or `mac`', 'App Store app id, obtain from the app URL https://itunes.apple.com/us/app/id1152443474, in this case, `id1152443474`']" />

-### In-App-Purchase Price Drop Alert
+#### In-App-Purchase Price Drop Alert

 <RouteEn author="HenryQW" example="/appstore/iap/us/id953286746" path="/appstore/iap/:country/:id" :paramsDesc="['App Store Country, obtain from the app URL https://itunes.apple.com/us/app/id953286746, in this case, `us`', 'App Store app id, obtain from the app URL https://itunes.apple.com/us/app/id953286746, in this case, `id953286746`']" />

 ### F-Droid

-### App Update
+#### App Update

 <RouteEn author="garywill" example="/fdroid/apprelease/com.termux" path="/fdroid/apprelease/:app" :paramsDesc="['App\'s package name']" />

 ### Greasy Fork

-### Script Update
+#### Script Update

 <RouteEn author="imlonghao" path="/greasyfork/:language/:domain?" example="/greasyfork/en/google.com" :paramsDesc="['language, located on the top right corner of Greasy Fork\'s search page, set to `all` for including all languages', 'the script\'s target domain']" />

 ### Thunderbird

-### Changelog
+#### Changelog

 <RouteEn author="garywill" example="/thunderbird/release" path="/thunderbird/release"/>

 ### Nvidia Web Driver

-### Changelog
+#### Changelog

 <RouteEn author="cielpy" example="/nvidia/webdriverupdate" path="/nvidia/webdriverupdate"/>

 ### Docker Hub

-### Image New Build
+#### Image New Build

 <RouteEn author="HenryQW" example="/dockerhub/build/wangqiru/ttrss" path="/dockerhub/build/:owner/:image/:tag?" :paramsDesc="['Image owner', 'Image name', 'Image tag，default to latest']"/>

@@ -219,15 +219,15 @@ If no matching results were found, the server returns only a HTTP status code `2

 ### pixiv

-### User Bookmark
+#### User Bookmark

 <RouteEn author="EYHN" path="/pixiv/user/bookmarks/:id" example="/pixiv/user/bookmarks/15288095" :paramsDesc="['user id, available in user\'s homepage URL']" />

-### User Activity
+#### User Activity

 <RouteEn author="EYHN" path="/pixiv/user/:id" example="/pixiv/user/15288095" :paramsDesc="['user id, available in user\'s homepage URL']" />

-### Rankings
+#### Rankings

 <RouteEn author="EYHN" path="/pixiv/ranking/:mode/:date?" example="/pixiv/ranking/week" :paramsDesc="['rank type', 'format: `2018-4-25`']" >

@@ -243,73 +243,111 @@ If no matching results were found, the server returns only a HTTP status code `2

 ### Disqus

-### Comment
+#### Comment

 <RouteEn path="/disqus/posts/:forum" example="/disqus/posts/diygod-me" :paramsDesc="['forum, disqus name of the target website']" />

 ### Twitter

-### User timeline
+#### User timeline

 <RouteEn path="/twitter/user/:id" example="/twitter/user/DIYgod" :paramsDesc="['user name']" />

-### List timeline
+#### List timeline

 <RouteEn author="xyqfer" example="/twitter/list/ladyleet/javascript" path="/twitter/list/:id/:name" :paramsDesc="['user name', 'list name']"/>

-### User likes
+#### User likes

 <Route author="xyqfer" example="/twitter/likes/DIYgod" path="/twitter/likes/:id" :paramsDesc="['user name']"/>

 ### Instagram

-### User
+#### User

 <RouteEn path="/instagram/user/:id" example="/instagram/user/diygod" :paramsDesc="['Instagram id']" />

-### Hashtag
+#### Hashtag

 <RouteEn author="widyakumara" path="/instagram/tag/:tag" example="/instagram/tag/urbantoys" :paramsDesc="['Instagram hashtag']" />

 ### Youtube

-### User
+#### User

 <RouteEn path="/youtube/user/:username/:embed?" example="/youtube/user/JFlaMusic" :paramsDesc="['YouTuber id', 'Default to embed the video, set to any value to disable embedding']" />

-### Channel
+#### Channel

 <RouteEn path="/youtube/channel/:id/:embed?" example="/youtube/channel/UCDwDMPOZfxVV0x_dz0eQ8KQ" :paramsDesc="['YouTube channel id', 'Default to embed the video, set to any value to disable embedding']" />

-### Playlist
+#### Playlist

 <RouteEn path="/youtube/playlist/:id/:embed?" example="/youtube/playlist/PLqQ1RwlxOgeLTJ1f3fNMSwhjVgaWKo_9Z" :paramsDesc="['YouTube playlist id', 'Default to embed the video, set to any value to disable embedding']" />

 ### Telegram

-### Channel
+#### Channel

-<RouteEn path="/telegram/channel/:username" example="/telegram/channel/awesomeDIYgod" :paramsDesc="['channel name']" >
+<RouteEn path="/telegram/channel/:username" example="/telegram/channel/awesomeDIYgod" :paramsDesc="['channel name']" />

-::: tip
+#### Sticker Pack

-Bot initialization required: add Telegram Bot [@RSSHub_bot](https://t.me/RSSHub_bot) as an admin to the channel and send at least one message in the channel for the bot to obtain the _chat_id_.
+<RouteEn author="DIYgod" example="/telegram/stickerpack/DIYgod" path="/telegram/stickerpack/:name" :paramsDesc="['Sticker Pack name, available in the sharing URL']"/>

-For private channels, pass the channel `id` (such as `-1001001234567`) intstead of `:username`. The easiest way to get id is [described here](https://stackoverflow.com/a/39943226/3160483).
+## Gaming

-:::
+### Steam
+
+#### Steam search
+
+<RouteEn author="maple3142" example="/steam/search/specials=1&term=atelier" path="/steam/search/:params" :paramsDesc="['search parameters']">
+
+Get serach parameters from the URL.
+
+For instance, in `https://store.steampowered.com/search/?specials=1&term=atelier`, the parameters are `specials=1&term=atelier`.

 </RouteEn>

-### Sticker Pack
+#### Steam news

-<RouteEn author="DIYgod" example="/telegram/stickerpack/DIYgod" path="/telegram/stickerpack/:name" :paramsDesc="['Sticker Pack name, available in the sharing URL']"/>
+<RouteEn author="maple3142" example="/steam/news/282800" path="/steam/news/:appids" :paramsDesc="['game id']"/>
+
+### SteamGifts
+
+#### Discussions
+
+<RouteEn author="whtsky" example="/steamgifts/discussions" path="/steamgifts/discussions/:category?" :paramsDesc="['category name, default to All']"/>
+
+### Nintendo
+
+#### eShop New Game Releases
+
+<RouteEn author="HFO4" example="/nintendo/eshop/hk" path="/nintendo/eshop/:region" :paramsDesc="['Region, currently supports `hk`(Hong Kong), `jp`(Japan) and `us`(USA)']"/>
+
+#### Nintendo Direct
+
+<RouteEn author="HFO4" example="/nintendo/direct" path="/nintendo/direct"/>
+
+#### News（Hong Kong only）
+
+<Route author="HFO4" example="/nintendo/news" path="/nintendo/news"/>
+
+## PlayStation Store
+
+### Game List（Hong Kong only）
+
+<RouteEn author="DIYgod" example="/ps/list/STORE-MSF86012-PLUS_FTT_CONTENT" path="/ps/list/:gridName" :paramsDesc="['gridName from the list']">
+
+Compatible with lists with an URL like <https://store.playstation.com/zh-hans-hk/grid/STORE-MSF86012-PLUS_FTT_CONTENT>. For instance [PSN Free to Play](https://store.playstation.com/zh-hans-hk/grid/STORE-MSF86012-PLUS_FTT_CONTENT), the gridName is STORE-MSF86012-PLUS_FTT_CONTENT
+
+</RouteEn>

 ## ACG

 ### Vol.moe

-### vol
+#### vol

 <RouteEn author="CoderTonyChan" example="/vol/finsh" path="/vol/:mode?" :paramsDesc="['mode type']">

@@ -323,7 +361,7 @@ For private channels, pass the channel `id` (such as `-1001001234567`) intstead

 ### All the Flight Deals

-### Flight Deals
+#### Flight Deals

 <RouteEn author="HenryQW" path="/atfd/:locations/:nearby?" example="/atfd/us+new%20york,gb+london/1" :paramsDesc="['the departing city, consists of an 「ISO 3166-1 country code」 and a 「city name」.  Origin\'s ISO 3166-1 country code + city name, eg. `us+new york`, [https://rsshub.app/atfd/us+new york](https://rsshub.app/atfd/us+new%20york). Multiple origins are supported via a comma separated string, eg. `us+new york,gb+london`, [https://rsshub.app/atfd/us+new york,gb+london/](https://rsshub.app/atfd/us+new%20york,gb+london/).', 'whether includes nearby airports, optional value of 0 or 1, default to 0 (exclude nearby airports)']" >

@@ -339,7 +377,7 @@ If the city name contains a space like `Mexico City`, replace the space with `%2

 ### Hopper

-### Flight Deals
+#### Flight Deals

 <RouteEn author="HenryQW" path="/hopper/:lowestOnly/:from/:to?" example="/hopper/1/LHR/PEK" :paramsDesc="['set to `1` will return the cheapest deal only, instead of all deals, so you don\'t get spammed', 'origin airport IATA code', 'destination airport IATA code, if unset the destination will be set to `anywhere`']" >

@@ -353,7 +391,7 @@ For airport IATA code please refer to [Wikipedia List of airports by IATA code](

 ### BBC

-### BBC
+#### BBC

 <RouteEn author="HenryQW" example="/bbc/chinese" path="/bbc/:channel?" :paramsDesc="['channel, default to `top stories`']">

@@ -382,29 +420,29 @@ GitHub provides some official RSS feeds:

 :::

-### User Repo
+#### User Repo

 <RouteEn author="dragon-yuan" path="/github/repos/:user" example="/github/repos/DIYgod" :paramsDesc="['GitHub username']" />

-### Trending
+#### Trending

 <RouteEn path="/github/trending/:since/:language?" example="/github/trending/daily/javascript" :paramsDesc="['time frame, available in [Trending page](https://github.com/trending/javascript?since=monthly) \'s URL, possible values are: daily, weekly or monthly', 'the feed language, available in [Trending page](https://github.com/trending/javascript?since=monthly) \'s URL']" />

-### Issue
+#### Issue

 <RouteEn author="HenryQW" path="/github/issue/:user/:repo" example="/github/issue/DIYgod/RSSHub" :paramsDesc="['GitHub username', 'GitHub repo name']" />

-### Follower
+#### Follower

 <RouteEn author="HenryQW" path="/github/user/follower/:user" example="/github/user/followers/HenryQW" :paramsDesc="['GitHub username']" />

-### Star
+#### Star

 <RouteEn author="HenryQW" path="/github/stars/:user/:repo" example="/github/stars/DIYGod/RSSHub" :paramsDesc="['GitHub username', 'GitHub repo name']" />

 ### GitLab

-### Explore
+#### Explore

 <RouteEn author="imlonghao" example="/gitlab/explore/trending" path="/gitlab/explore/:type" :paramsDesc="['type']">

@@ -418,7 +456,7 @@ GitHub provides some official RSS feeds:

 ### Hermes

-### Hermes UK
+#### Hermes UK

 <RouteEn author="HenryQW" example="/parcel/hermesuk/[tracking number]" path="/parcel/hermesuk/:tracking" :paramsDesc="['Tracking number']"/>

@@ -432,23 +470,23 @@ EZTV provides an official RSS feed of all torrents: https://eztv.ag/ezrss.xml

 :::

-### Torrent Lookup by IMDB ID
+#### Torrent Lookup by IMDB ID

 <RouteEn author="Songkeys" path="/eztv/torrents/:imdb_id" example="/eztv/torrents/6048596" :paramsDesc="['search for the IMDB ID of the desired show, available at [IMDB](https://www.imdb.com)']" />

 ### Hexo Blog

-### Blog using Next theme
+#### Blog using Next theme

 <RouteEn author="fengkx" path="/hexo/next/:url" example="/hexo/next/fengkx.top" :paramsDesc="['the blog URL without the protocol (http:// and https://)']" />

-### Blog using Yilia theme
+#### Blog using Yilia theme

 <RouteEn author="aha2mao" path="/hexo/yilia/:url" example="/hexo/yilia/cloudstone.xin" :paramsDesc="['the blog URL without the protocol (http:// and https://)']" />

 ### Google

-### Google Scholar Keywords Monitoring
+#### Google Scholar Keywords Monitoring

 <RouteEn author="HenryQW" path="/google/scholar/:query" example="/google/scholar/data+visualization" :paramsDesc="['query statement which supports「Basic」and「Advanced」modes']" >

@@ -466,28 +504,26 @@ Google Scholar has strict anti-crawling mechanism implemented, the demo below do

 ### Dribbble

-### Popular
+#### Popular

 <RouteEn path="/dribbble/popular/:timeframe?" example="/dribbble/popular" :paramsDesc="['support the following values: week, month, year and ever']" />

-### User (or team)
+#### User (or team)

 <RouteEn path="/dribbble/user/:name" example="/dribbble/user/google" :paramsDesc="['username, available in user\'s homepage URL']" />

-### Keyword
+#### Keyword

 <RouteEn path="/dribbble/keyword/:keyword" example="/dribbble/keyword/player" :paramsDesc="['desired keyword']" />

 ### Apple

-### Exchange and Repair Extension Programs
+#### Exchange and Repair Extension Programs

 <RouteEn author="metowolf HenryQW" example="/apple/exchange_repair" path="/apple/exchange_repair/:country?" :paramsDesc="['country code in apple.com URL (exception: for `United States` please use `us`), default to China `cn`']" />

 ### The Verge

-### The Verge
-
 <RouteEn author="HenryQW" example="/verge" path="/verge">

 Provides a better reading experience (full text articles) over the official one.
@@ -496,13 +532,13 @@ Provides a better reading experience (full text articles) over the official one.

 ### 99% Invisible

-### Transcript
+#### Transcript

 <RouteEn author="Ji4n1ng" example="/99percentinvisible/transcript" path="/99percentinvisible/transcript"/>

 ### AutoTrader

-### Search
+#### Search

 <RouteEn author="HenryQW" example="/autotrader/radius=50&postcode=sw1a1aa&onesearchad=Used&onesearchad=Nearly%20New&onesearchad=New&price-to=9000&year-from=2012&body-type=Hatchback&transmission=Automatic&exclude-writeoff-categories=on" path="/autotrader/:query" :paramsDesc="['the search query']">

@@ -513,13 +549,13 @@ Provides a better reading experience (full text articles) over the official one.

 ### United Nations

-### Security Council Vetoed a Resolution
+#### Security Council Vetoed a Resolution

 <RouteEn author="HenryQW" example="/un/scveto" path="/un/scveto"/>

 ### The Guardian

-### Editorial
+#### Editorial

 <RouteEn author="HenryQW" example="/guardian/editorial" path="/guardian/editorial">

@@ -529,7 +565,7 @@ Provides a better reading experience (full text articles) over the official one.

 ### iDownloadBlog

-### iDownloadBlog
+#### iDownloadBlog

 <RouteEn author="HenryQW" example="/iDownloadBlog" path="/iDownloadBlog/index">

@@ -539,7 +575,7 @@ Provides a better reading experience (full text articles) over the official one.

 ### 9To5

-### 9To5 Sub-site
+#### 9To5 Sub-site

 <RouteEn author="HenryQW" example="/9to5/mac" path="/9to5/:type" :paramsDesc="['The sub-site name']">

@@ -552,6 +588,6 @@ Supported sub-sites：

 ### All Poetry

-### Poems
+#### Poems

 <RouteEn author="HenryQW" example="/allpoetry/newest" path="/allpoetry/:order?" :paramsDesc="['order by type, `best` or `newest`, default to `best`']"/>
--- a/docs/en/install/README.md
+++ b/docs/en/install/README.md
@@ -302,7 +302,7 @@ When adding feeds using RSS readers with HTTP Basic Authentication support, auth

 ### Route-specific Configurations

-   `pixiv`: [registration](https://accounts.pixiv.net/signup)
+-   `pixiv`: [Registration](https://accounts.pixiv.net/signup)

    -   `PIXIV_USERNAME`: Pixiv username

@@ -312,7 +312,7 @@ When adding feeds using RSS readers with HTTP Basic Authentication support, auth

    -   `DISQUS_API_KEY`: Disqus API

-   `twitter`: [application creation](https://apps.twitter.com)
+-   `twitter`: [Application creation](https://apps.twitter.com)

    -   `TWITTER_CONSUMER_KEY`: Twitter Consumer Key, support multiple keys, split them with `,`