From ec9a4da775d14a0dbca1aa1d54b8a11a9b004259 Mon Sep 17 00:00:00 2001 From: Martin Dosch Date: Sun, 15 Jul 2018 12:23:11 +0200 Subject: [PATCH] Changed README [markdown-lint]. --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ada64b7..4b955f0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +# feed-to-muc + ## about *feed-to-muc* is a XMPP which queries Atom or RSS newsfeeds and @@ -6,9 +8,10 @@ posts the short summary to a XMPP MUC if there is a new article. ## disclaimer I am no programmer and this bot is a result of a lot of *try and error*. -There are probably lots of quirks that are remains of some wrong paths +There are probably lots of quirks that are remains of some wrong paths I went in between. Also a lot is probably solved in a *hacky way* due -to missing experience. +to missing experience. + Anyway, it works (for me at least) and so I upload this here. Recommendations about what can be done better improved and so on are very welcome. @@ -19,10 +22,10 @@ very welcome. ## installation -If you have *[GOPATH](https://github.com/golang/go/wiki/SettingGOPATH)* +If you have *[GOPATH](https://github.com/golang/go/wiki/SettingGOPATH)* set just run this commands: -``` +```bash $ go get salsa.debian.org/mdosch-guest/feed-to-muc $ go install salsa.debian.org/mdosch-guest/feed-to-muc ``` @@ -31,10 +34,10 @@ You will find the binary in `$GOPATH/bin` or, if set, `$GOBIN`. ## configuration -If the flag `-config` is not used tthe configuration expected at +If the flag `-config` is not used tthe configuration expected at `$HOME/.config/feed-to-muc/config.json` in this format: -``` +```json { "ServerAddress": "example.com:5222", "BotJid": "feedbot@example.com", @@ -42,7 +45,7 @@ If the flag `-config` is not used tthe configuration expected at "Muc": "muc-to-feed@conference.example.com", "MucNick": "feedbot", "MaxArticles": 5, -"Feeds": [ "https://www.debian.org/News/news", +"Feeds": [ "https://www.debian.org/News/news", "https://www.debian.org/security/dsa-long" ] } ```