commit 507bd26628450fcc45fc5118c3211b7d58169087
parent cd0201956859aacfec4991f199f1ca5406b98301
Author: Emile 'iMil' Heitor <imil@NetBSD.org>
Date: Tue, 18 Jul 2023 08:38:17 +0200
docs: updated README
Diffstat:
1 file changed, 12 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -1,7 +1,17 @@
# Gruik, your news source
-_Gruik_ is a very basic _IRC_ bot written in Go that fetches _RSS_ feeds and prints them on a
-chosen channel.
+_Gruik_ is an _IRC_ bot written in Go that fetches _RSS_ feeds and prints them on a
+chosen channel.
+It has no database and focuses on news freshness, it will store a `ringsize` number of news
+which rotate as news come in.
+_Gruik_ supports _x-posting_ meaning that it can join other channels than the main one so you
+can post curated news using their hash, so the _x-post_ channels only receive a controlled
+number of news.
+
+* `maxnews` is the maximum number of news fetched from an _origin_
+* `maxage` is the maximum news age, no news older than this will be fetched
+* `frequency` is the refresh frequency
+* `ringsize` is the number of news to keep on memory, disk, and rotate on
## Configuration
