aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md57
1 files changed, 37 insertions, 20 deletions
diff --git a/README.md b/README.md
index 10097d7..cbcafdc 100644
--- a/README.md
+++ b/README.md
@@ -26,27 +26,44 @@ make install
make uninstall
```
-## /** FEATURES **/
- 1. Able to add tasks. (toradora -a "The task I want to add")
- 2. Able to complete those tasks. (toradora -c 1 )
- 3. Able to edit those tasks. (toradora -e 1 "The previous task edited")
- 4. Able to manifest those tasks. (toradora)
- > ===============================
-
- > |>>> Today's Task <<<
-
- > |1. "task one"
-
- > |2. "task two"
-
- > |>>> Backlogs <<<
-
- > |3. "task three"
-
- > |===============================
-
- 5. Able to manifest all the tasks in database. (toradora -z)
+## Features
+
+ 1. Add tasks. `toradora -a "The task I want to add"`
+ 2. Add tasks with priority. `toradora -a "urgent fix" -p 1`
+ 3. Add daily tasks (always shown). `toradora -d "morning run"`
+ 4. Add daily tasks with priority. `toradora -d "read" -p 1`
+ 5. Complete tasks. `toradora -c 1`
+ 6. Edit tasks. `toradora -e 1 "The previous task edited"`
+ 7. Manifest tasks. `toradora`
+
+```
+----------------------------------------------
+>>> Daily <<<
+ [!] 2. read for 30 mins
+ [~] 1. morning run
+
+>>> Today's Tasks <<<
+ [!] 3. fix the login bug
+ [~] 4. write tests
+ [ ] 5. update docs
+
+>>> Backlog <<<
+ [~] 6. old task from yesterday
+----------------------------------------------
+```
+
+ 8. Show all tasks ever recorded. `toradora -z`
+
+## Priority Levels
+
+| Flag | Symbol | Meaning |
+|-------|--------|---------|
+| `-p 1` | `[!]` | High |
+| `-p 2` | `[~]` | Medium (default) |
+| `-p 3` | `[ ]` | Low |
## Notes
The DB is currently stored at `~/.toradora.db`
+
+New columns (`priority`, `daily`) are automatically added to existing databases on first run.