update README

This commit is contained in:
Thomas Koch 2025-01-13 09:26:36 +02:00
parent 917aed0247
commit f333fe2b22
2 changed files with 15 additions and 4 deletions

View File

@ -1,6 +1,6 @@
[package]
name = "planet-mars"
version = "0.1.0"
version = "0.1.1"
edition = "2021"
authors = ["Thomas Koch <thomas@koch.ro>"]
description = "Feed aggregation planet like Planet Venus, produces static HTML and ATOM feed from fetched feeds."

View File

@ -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: