From 91acec498bf36da811d83c1308d28794baf1fafb Mon Sep 17 00:00:00 2001 From: hornetfighter515 Date: Fri, 23 Jul 2021 21:58:57 -0400 Subject: [PATCH] README english --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2c4dc72..40b8f91 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ and then add the following lines to your [`crontab`][cron]: ``` 3. Copy the code in [`hack-news-widget.html`](src/hack-news-widget.html) to where you want your news widget on your webpage. ## How it works -The [`xml-download.py`](src/ef/xml-download.py) file downloads the RSS feed from the provided endpoint. Theoretically this hardcoded endpoint, but this is specifically designed for [Hacker News][hn]. The reason this isn't just placed in the webpage code is to prevent CORS errors and vulnerabilities. +The [`xml-download.py`](src/ef/xml-download.py) file downloads the RSS feed from the provided endpoint. Theoretically this hardcoded endpoint could be replaced with any RSS URL, but this is specifically designed for [Hacker News][hn]. The reason this isn't just placed in the webpage code is to prevent CORS errors and vulnerabilities. The Python 3.8 code downloads the RSS feed into the [`src/ef/feed.xml`](src/ef/feed.xml) file. It then takes that feed and translates it into a pretty HTML template. The template includes references to the following files: * [`news_scroll.js`](src/ef/news_scroll.js), which controls the scrolling animation.