commit ccd1c04025abf1662847f4fea161eda13fc3bc93
parent 768f153f360761dfe37c0365fb04caa1fd4197f3
Author: Emile 'iMil' Heitor <imil@NetBSD.org>
Date: Tue, 11 Jul 2023 19:08:30 +0200
added README and LICENSE
Diffstat:
| A | LICENSE | | | 13 | +++++++++++++ |
| A | README.md | | | 39 | +++++++++++++++++++++++++++++++++++++++ |
2 files changed, 52 insertions(+), 0 deletions(-)
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,13 @@
+ DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+ Version 2, December 2004
+
+Copyright (C) 2023 Emile `iMil' Heitor <imil@imil.net>
+
+Everyone is permitted to copy and distribute verbatim or modified
+copies of this license document, and changing it is allowed as long
+as the name is changed.
+
+ DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. You just DO WHAT THE FUCK YOU WANT TO.
diff --git a/README.md b/README.md
@@ -0,0 +1,39 @@
+# 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.
+
+## Configuration
+
+Here's a sample `config.yaml` file:
+
+```yaml
+irc:
+ server: irc.libera.chat
+ nick: Gruik
+ password: piggypiggy # optional
+ channel: myfeedz
+ debug: false # optional
+ port: 6667 # optional
+
+feeds:
+ urls:
+ - https://news.ycombinator.com/rss
+ - https://rss.slashdot.org/Slashdot/slashdotMain
+ - https://www.osnews.com/feed/
+ - https://www.reutersagency.com/feed/
+ - https://lwn.net/headlines/rss
+ - https://www.phoronix.com/rss.php
+ - https://lobste.rs/rss
+ maxnews: 10 # optional
+ maxage: 1h # optional
+ frequency: 5m # optional
+```
+
+## Usage
+
+```shell
+$ ./Gruik
+```
+
+An alternate configuration file can be given as a parameter.
