From f333fe2b2205cdcc7578ad6bd3ad9504d6baad94 Mon Sep 17 00:00:00 2001 From: Thomas Koch Date: Mon, 13 Jan 2025 09:26:36 +0200 Subject: [PATCH] update README --- Cargo.toml | 2 +- README.md | 17 ++++++++++++++--- 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index b5e00a0..400ac83 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "planet-mars" -version = "0.1.0" +version = "0.1.1" edition = "2021" authors = ["Thomas Koch "] description = "Feed aggregation planet like Planet Venus, produces static HTML and ATOM feed from fetched feeds." diff --git a/README.md b/README.md index 664fb79..467fdeb 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,24 @@ -Simple planet like planet venus but in rust and maintained. +Simple successor to Planet Venus but in Rust and maintained. Please see the rustdoc of main.rs for further information. -## todo +## Todo -* use a nice lib to process the config file +* find and use a nice lib to process the config file * should check whether dirs exists and are writeable * should check whether feed urls can be parsed +## Planet Venus + +Planet Venus is used by many planets on the internet. However its code has not +been maintained since ~2011 and it uses Python 2. + +Planet Mars should be a lightweight successor to Planet Venus. + +Still the Planet Venus documentation contains some useful information on +[Etiquette](https://intertwingly.net/code/venus/docs/etiquette.html) for +Planet hosters. + ## Credits While writing this, I read and also copied code from: