roughnecks/feed-to-muc
1
0
Fork 0
mirror of https://salsa.debian.org/mdosch/feed-to-muc.git synced 2024-09-19 23:10:52 +02:00
Code Issues Projects Releases Packages Wiki Activity

Changed README [markdown-lint].

Browse source
This commit is contained in:
Martin Dosch 2018-07-15 12:23:11 +02:00
parent 6b21b9b749
commit ec9a4da775
1 changed files with 10 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -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" ]
}
```