Skip to content

Commit

Permalink
docs: add FAQs in English (DIYgod#2502)
Browse files Browse the repository at this point in the history
  • Loading branch information
HenryQW authored and DIYgod committed Jun 27, 2019
1 parent a45642d commit 86704e5
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions docs/en/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,29 @@ RSSHub is a lightweight and extensible RSS feed aggregator, it's able to generat
| :----------------------------------------------------------: | :--------------------------------------: | :----------------------------------------: | :--: | :----------------------------------: |


[![](https://opencollective.com/static/images/become_sponsor.svg)](https://docs.rsshub.app/support/)
[![](https://opencollective.com/static/images/become_sponsor.svg)](/support/)

## FAQs

**Q: How does RSSHub work?**

**A:** When a request is received, RSSHub fetches the corresponding data from the original site, the result ing contents will be output in RSS format. Caching is implemented to avoid requesting original sites for content. And of course, we throw in a little magic 🎩.

**Q: Can I use the demo instance?**

**A:** [rsshub.app](https://rsshub.app) is the demo instance provided, running the latest build of RSSHub from master branch, the cache is set 20 minutes and it's free to use. However, popular websites such as Instagram and YouTube etc. may pose a request quota on individual IP address, which means it can get unreliable from time to time for the demo instance. You are encouraged to [host your own RSSHub instance](/en/install/) for a better usability.

**Q: Why are images not loading in some RSSHub routes?**

**A:** RSSHub fetches and respects the original image URLs from original sites, `referrerpolicy="no-referrer"` attribute is added to all images to solve the issues caused by cross-domain requests. Third party RSS service providers such as Feedly and Inoreader, strip this attribute off which leads to cross-domain requests being blocked.

**Q: The website I want is not supported QAQ**

**A:** If you are a JavaScript developer, please follow [this guide](/joinus) for submitting a pull request, otherwise, follow the issue template to [submit a new issue](https://github.com/DIYgod/RSSHub/issues/new?template=rss_request_en.md), and patiently wait for Santa Claus. For priority responses, consider [sponsoring us](/support).

**Q: Where do I get the changelog for RSSHub?**

**A:** Subscribe our RSS here: [RSSHub added a new route](/en/#rsshub).

### Contributors

Expand Down Expand Up @@ -83,7 +105,7 @@ Eg: Dribbble Popular Top 10 [https://rsshub.app/dribbble/popular?limit=10](https

RSSHub supports RSS 2.0 and Atom as the output formats, simply append `.rss` `.atom` to the end of the feed address, default to RSS 2.0

For exmaple:
For example:

- Default (RSS 2.0) - [https://rsshub.app/dribbble/popular](https://rsshub.app/dribbble/popular)
- RSS 2.0 - [https://rsshub.app/dribbble/popular.rss](https://rsshub.app/dribbble/popular.rss)
Expand Down

0 comments on commit 86704e5

Please sign in to comment.