From d050f00afebef8b96bf75a83adfb2d539dd38b56 Mon Sep 17 00:00:00 2001 From: Denis Lehmann Date: Wed, 15 Apr 2020 00:22:55 +0200 Subject: [PATCH] edit README --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c6772bb..f3cea69 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ![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). -Actually it is just a python script. +Actually, it's just a python script. Read the news you want, the way you want it. 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. +__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 - Store articles in categories @@ -21,9 +25,11 @@ Articles are parsed as Markdown files from the original article web page and sto ## Installation +Until now there is no install method, just ways to call the script. + ### 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