From 181dfddbdd0db5e259339bce23829e9ef9739c1e Mon Sep 17 00:00:00 2001 From: Alvie Rahman Date: Sun, 8 Jul 2018 22:29:13 +0100 Subject: [PATCH] Add README.md --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..26186ac --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# todo.txt as a Telegram bot +A bot to hold your todo.txt tasks + +## commands +All commands require a preceding `/`. +- add - add a task +- rm - remove a task, requires task id +- ls - list tasks, use 'f[ilter]:FILTERTEXT' syntax to search +- do - complete a task, requires task id +- undo - undo a task, requires task id +- marco - responds 'polo', tests the bot it up + +If no command is specified, it is assumed to be the add command. + + +## todo +- exporting all tasks +- favourite commands +- reminders for tasks with due dates +- use a real database instead of json files