prehistoric-systems/osmosfeed-template
1
0
Fork 0
mirror of https://github.com/osmoscraft/osmosfeed-template.git synced 2026-03-11 14:44:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update template documentation

Browse source
This commit is contained in:
Chuanqi Sun 2021-04-11 15:22:37 -07:00
parent e298bb05c3
commit 71da14dd14
1 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -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).