From d196454ddec732abc1a2f8518ad633265cb773e6 Mon Sep 17 00:00:00 2001 From: Glenn Date: Sun, 15 Jan 2023 19:17:44 +0100 Subject: [PATCH] doc: Shorten content --- README.md | 80 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 44 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 75d4c3e..579977b 100644 --- a/README.md +++ b/README.md @@ -9,44 +9,48 @@ Every morning, get the content of your favorite kanban board by email, WhatsApp Note: _musala_ means _work, occupation_ [in Lingala](https://dic.lingala.be/fr/mosala) ## Roadmap + - [API Reference](https://github.com/nextcloud/deck/blob/master/docs/API.md) + - [API Reference](https://github.com/wekan/wekan/wiki/REST-API) -Task sources: +* Multiple task sources: + :heavy_check_mark: __Trello__ + – :x: Nextcloud Deck (not yet) + – :x: Wekan (not yet) + – :x: Gitea / Forgejo (not yet) + – :x: Libreboard (not yet) + – :x: Github Projects (not yet) +* Multiple task destinations: + :x: Trello + – :x: Nextcloud Deck (not yet) + – :x: Wekan (not yet) + – :x: Gitea / Forgejo (not yet) + – :x: Libreboard (not yet) + – :x: Github Projects (not yet) +* Data selection: :heavy_check_mark: __All boards__ + :heavy_check_mark: __Favorited boards__ + – :heavy_check_mark: __Only selected ones__ -* :heavy_check_mark: __Trello__ -* :x: Nextcloud Deck (not yet) - [API Reference](https://github.com/nextcloud/deck/blob/master/docs/API.md) -* :x: Wekan (not yet) - [API Reference](https://github.com/wekan/wekan/wiki/REST-API) -* :x: Gitea / Forgejo (not yet) -* :x: Libreboard (not yet) -* :x: Github Projects (not yet) +* Task actions: + :heavy_check_mark: __List tasks__ + – :x: Create task + – :x: Read task + – :x: Update task + – :x: Remove task +* Delivery via: + :heavy_check_mark: __E-mail__ + – :x: Terminal + – :x: Webhook + – :x: UnifiedPush + – :x: Telegram + – :x: Slack + – :x: SMS + – :x: Whatsapp + – :x: IRC -Source selection - -* :heavy_check_mark: __All of them__ -* :heavy_check_mark: __Favorited boards__ -* :heavy_check_mark: __Only selected ones__ - -Actions - -* :heavy_check_mark: __List tasks__ -* :x: Create task -* :x: Read task -* :x: Update task -* :x: Remove task - -Delivery via: - -* :heavy_check_mark: __E-mail__ -* :x: Terminal -* :x: Telegram -* :x: Slack -* :x: SMS -* :x: Whatsapp -* :x: IRC - -User interface for account configuration - -* :heavy_check_mark: Command line + environment variables -* :x: Web app +UI for task management: + :heavy_check_mark: Simple CLI + environment variables + – :x: Composable CLI + environment variables + – :x: Web UI ## Installation @@ -54,7 +58,11 @@ User interface for account configuration Make sure you have Go installed, then type: - $ go install github.com/glenux/musala/... + $ go install github.com/glenux/musala/...@master + +or + + $ go install code.apps.glenux.net/glenux/musala/...@master It will install Musala Mail binary in `$GOPATH/bin`