glenux/musala
glenux/musala
1
0
Fork 0
Code Issues 7 Pull requests Projects 1 Releases Wiki Activity

doc: Shorten content & improve display

Browse source
This commit is contained in:
Glenn Y. Rolland 2023-01-15 19:17:44 +01:00
parent 754ed0f898
commit 2fae0eb496
1 changed files with 35 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
README.md
View file

@ -10,43 +10,46 @@ Note: _musala_ means _work, occupation_ [in Lingala](https://dic.lingala.be/fr/m
## Roadmap
Task sources:
Multiple task sources & destinations:
* :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)
* :x: Nextcloud Deck (not yet)
/ Wekan (not yet)
/ Gitea / Forgejo (not yet)
/ Libreboard (not yet)
/ Github Projects (not yet)
Source selection
Board Data selection:
* :heavy_check_mark: __All of them__
* :heavy_check_mark: __Favorited boards__
* :heavy_check_mark: __Only selected ones__
* :heavy_check_mark: __All boards__
/ __Favorited boards__
/ __Only selected ones__
Actions
Task actions:
* :heavy_check_mark: __List tasks__
* :x: Create task
* :x: Read task
* :x: Update task
* :x: Remove task
/ Read task
/ Update task
/ Remove task
Delivery via:
* :heavy_check_mark: __E-mail__
* :x: Terminal
* :x: Telegram
* :x: Slack
* :x: SMS
* :x: Whatsapp
* :x: IRC
/ Webhook
/ UnifiedPush
/ Telegram
/ Slack
/ SMS
/ Whatsapp
/ IRC
User interface for account configuration
UI for task management:
* :heavy_check_mark: Command line + environment variables
* :x: Web app
* :heavy_check_mark: Simple CLI + environment variables
* :x: Composable CLI + environment variables
/ Web UI
## Installation
@ -54,7 +57,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`
@ -149,4 +156,7 @@ Musala is Copyright © 2018-2021 Glenn ROLLAND. It is free software, and may be
Following projects may also inspire you:
* [72nd/deck-cli](https://github.com/72nd/deck-cli): a command-line tool for interacting with Nextcloud's Deck Plugin by using it's API
* [Nextcloud API Reference](https://github.com/nextcloud/deck/blob/master/docs/API.md)
* [Wekan API Reference](https://github.com/wekan/wekan/wiki/REST-API)
* [Gitea API Usage](https://docs.gitea.io/en-us/api-usage/) and [Gitea API Reference](https://try.gitea.io/api/swagger)