denis/spiderss
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

edit README

Browse source
This commit is contained in:
Denis Lehmann 2020-04-15 00:22:55 +02:00
parent 915703d1c4
commit d050f00afe
1 changed files with 8 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -3,7 +3,7 @@
![spiderss logo](images/logo.png) ![spiderss logo](images/logo.png)
__spiderss__ is a plaintext RSS crawler, based on [feedparser](https://github.com/kurtmckee/feedparser), [python-readability](https://github.com/buriy/python-readability) and [html2text](https://github.com/Alir3z4/html2text). __spiderss__ is a plaintext RSS crawler, based on [feedparser](https://github.com/kurtmckee/feedparser), [python-readability](https://github.com/buriy/python-readability) and [html2text](https://github.com/Alir3z4/html2text).
Actually it is just a python script. Actually, it's just a python script.
Read the news you want, the way you want it. Read the news you want, the way you want it.
Without advertisements, clickbait and trackers. Without advertisements, clickbait and trackers.
@ -11,6 +11,10 @@ Drop unresponsive web interfaces and stop accepting cookies, because plaintext i
Articles are parsed as Markdown files from the original article web page and stored on the filesystem. Articles are parsed as Markdown files from the original article web page and stored on the filesystem.
__Note:__ This script is under development and far from being complete.
Until now it works for the most feeds I read.
Use at your own risk!
## Features ## Features
- Store articles in categories - Store articles in categories
@ -21,9 +25,11 @@ Articles are parsed as Markdown files from the original article web page and sto
## Installation ## Installation
Until now there is no install method, just ways to call the script.
### NixOS ### NixOS
Just call `nix-shell` in the project directory. This will drop you into a python environment with all requirements fulfilled Call `nix-shell` in the project directory. This will drop you into a python environment with all necessary requirements.
### Legacy OS ### Legacy OS