From 71da14dd14e503a653dd00bb81c212f74b89fb37 Mon Sep 17 00:00:00 2001 From: Chuanqi Sun Date: Sun, 11 Apr 2021 15:22:37 -0700 Subject: [PATCH] update template documentation --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 37694a3..a3ea857 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,17 @@ -This is a self-hosted RSS feed. Please refer to the [latest documentation](https://github.com/osmoscraft/osmosfeed). +# About + +This is repository hosts the UI and content of an RSS feed reader. + +## How does this work - The site is statically hosted by GitHub Pages. There is no server to fetch content on the fly. - The content is updated periodically by GitHub Actions, configured in `/.github/workflows/update-feed.yaml`. - The source of the content can be any RSS feed URL, configured in `/osmosfeed.yaml`. - The content fetching and static site generation is powered by [osmosfeed](https://github.com/osmoscraft/osmosfeed). +- The repository is generated from a [template](https://github.com/osmoscraft/osmosfeed-template). + +## References + +- [File an issue about the template](https://github.com/osmoscraft/osmosfeed-template). +- [File an issue about the tool](https://github.com/osmoscraft/osmosfeed). +- [The lastest documentation](https://github.com/osmoscraft/osmosfeed).