From 9d3014550b8861ca0ce04d45b4a04624d63ae421 Mon Sep 17 00:00:00 2001 From: Felipe M Date: Fri, 17 Jul 2020 10:03:51 +0200 Subject: [PATCH] Updated README.md --- README.md | 28 +++++++++++----------------- 1 file changed, 11 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 465e7df..9e4a687 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # Butter Robot -[![Docker Repository on Quay](https://quay.io/repository/fmartingr/butterrobot/status "Docker Repository on Quay")](https://quay.io/repository/fmartingr/butterrobot) +![Build stable tag docker image](https://github.com/fmartingr/butterrobot/workflows/Build%20stable%20tag%20docker%20image/badge.svg?branch=stable) +![Build latest tag docker image](https://github.com/fmartingr/butterrobot/workflows/Build%20latest%20tag%20docker%20image/badge.svg?branch=master) Python framework to create bots for several platforms. @@ -13,28 +14,22 @@ Python framework to create bots for several platforms. | Name | Receive messages | Send messages | | --------------- | ---------------- | ------------- | | Slack (app) | Yes | Yes | -| Slack (webhook) | Planned | No[^1] | | Telegram | Yes | Yes | -[^1]: Slack webhooks only supports answering to incoming event, not - sending messages on demand. - ## Provided plugins -### Butter robot - -- [ ] Help -- [ ] Usage -- [ ] Changelog ### Development -- [x] Ping +#### Ping + + Say `!ping` to get response with time elapsed. ### Fun and entertainment -- [ ] Dice roll -- [x] Loquito +#### Loquito + + What happens when you say _"lo quito"_...? (Spanish pun) ## Installation @@ -51,11 +46,12 @@ $ python -m butterrobot ### Containers -The `fmartingr/butterrobot` container image is published on quay.io to +The `fmartingr/butterrobot/butterrobot` container image is published on Github packages to use with your favourite tool: ``` -podman run -d --name butterrobot -p 8080:8080 quay.io/fmartingr/butterrobot +docker pull docker.pkg.github.com/fmartingr/butterrobot/butterrobot:latest +podman run -d --name fmartingr/butterrobot/butterrobot -p 8080:8080 ``` ## Contributing @@ -79,8 +75,6 @@ TELEGRAM_TOKEN=xxx And then you can run it directly with poetry -TODO: Autoload .env-local - ``` docker run -it --rm --env-file .env-local -p 5000:5000 -v $PWD/butterrobot:/etc/app/butterrobot local/butterrobot python -m butterrobot ```