marc/rss-reader
1
0
Fork 0
Code Issues 5 Pull requests 10 Projects Releases Packages Wiki Activity

docs: more README

Browse source
This commit is contained in:
Marc 2021-07-17 12:57:33 -04:00
parent 99413c7d8d
commit 71ea5ce07b
1 changed files with 19 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -1,5 +1,23 @@
# rss-reader
# Yet Another RSS Reader (YARR) :pirate_flag:
## Overview
In a never-ending DIY quest, I've put together this RSS feed reader to keep up with the news. The main requirement
observed here is to _not_ require any sort of backend (except for a serverless proxy to get around CORS) and to keep it
all as simple as possible.
<img src="./assets/overview.png"/>
The reader allows the user to provide RSS feed URLs that should be pulled, settings and fetched results are cached using
[browser local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) if it's available. The
results caching is also used to prevent refetches on load if the cache is fresh enough.
The whole thing runs on [Netlify](https://www.netlify.com/)'s generous free tier.
Feel free to use it for your own RSS needs and to [drop a word or
two](https://github.com/mcataford/rss-reader/discussions/10) if you do. :tada:
## Contributing
The project welcomes contributions as long as they fit within the general roadmap, which is still TBD. Any contribution
making the bundle smaller will be eagerly reviewed and celebrated as long as it preserves functionality.