From e298bb05c3c60c6d0dcd706ddd62e4394fa4a0f8 Mon Sep 17 00:00:00 2001 From: Chuanqi Sun Date: Sun, 11 Apr 2021 15:10:28 -0700 Subject: [PATCH] Update the README --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..37694a3 --- /dev/null +++ b/README.md @@ -0,0 +1,6 @@ +This is a self-hosted RSS feed. Please refer to the [latest documentation](https://github.com/osmoscraft/osmosfeed). + +- 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).