From ef34e45ed4127210ef64e17a58938d2b3b60fbaf Mon Sep 17 00:00:00 2001 From: hornet <43388240+hornetfighter515@users.noreply.github.com> Date: Fri, 23 Jul 2021 21:50:27 -0400 Subject: [PATCH] Update README.md removed horizontal rules --- README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/README.md b/README.md index 5bd1715..2c4dc72 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # [The Hacker News][hn] RSS Widget With this widget, you can add a news feed from The Hacker News to any website based on a Linux server. -___ ## Setup 1. Drag the [`src/ef/`](src/ef/) folder into the same folder as the webpage on the target machine. The folder with your webpage will be represented by `/path_to_webpage/`. @@ -14,7 +13,6 @@ and then add the following lines to your [`crontab`][cron]: 0 * * * * cd /path_to_webpage/ef/ && python3 xml-download.py ``` 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. @@ -22,14 +20,11 @@ The Python 3.8 code downloads the RSS feed into the [`src/ef/feed.xml`](src/ef/f * [`news_scroll.js`](src/ef/news_scroll.js), which controls the scrolling animation. * [`news_scroll.css`][nsc], which has a reference to the fancy terminal-based color scheme in [`palette.css`][pc], as well as styling to control the size of the entire widget. -___ ## UX Configuration The best place to look for customizing this template to your liking is in [`news_scroll.css`][nsc]. Width, text decoration, and font sizes can be adjust from there. If fonts or colors are what you're looking to adjust, check the `terminal` theme in [`palette.css`][pc]. It can be copied and pasted within the file, and then adjusted to your liking. In order to apply it to the widget, change the `color_theme` variable in [`news_scroll.js`](src/ef/news_scroll.js) to the name of your theme. Alternatively, try some of the default themes, such as `hornetfighter-red` and `hornetfighter-blue`, based on the color palette from [my website](https://hornetfighter.com/). -___ ## Samples * [Sample Configuration on template for my website](src/sample_1.html) * [Minimum viable configuration](src/sample_2.html) -___ ## Dependencies * [`cron`][cron] (or a similar job scheduler) * [`requests`](https://pypi.org/project/requests/)