summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAriadna Vigo <arivigodr@gmail.com>2020-06-24 18:13:54 +0200
committerAriadna Vigo <arivigodr@gmail.com>2020-06-24 18:13:54 +0200
commit2cfc535d80a15536fd1a441ba725d5961cdf9d7c (patch)
tree52f68de70da909863717d1974853ea5e29e3f548 /README.md
parent445bc4c3386d05513d3e140f2b02d2a1d2cd6543 (diff)
Cras now uses a filepath provided at the CLI
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 10 insertions, 9 deletions
diff --git a/README.md b/README.md
index f3cd026..1e624da 100644
--- a/README.md
+++ b/README.md
@@ -18,11 +18,12 @@ $ make
### Set up your task list
To start using Cras, you first need to set up your task list. This is done by
-using the -s command line option and entering a short description of your task
-in a new line. End your list hitting EOF (Ctrl+D) in a *blank line*.
+using the -s command line option and a file name. Then enter a short
+description of your task in a new line. End your list hitting EOF (Ctrl+D) in a
+ *blank line*.
```
-$ cras -s
+$ cras -s mytask
First task
Second task
Third task
@@ -31,16 +32,16 @@ Third task
You may also pipe in a text file if you so prefer.
```
-$ cras -s < mytasklist
+$ cras -s todo-today < mytasklist
```
### Printing out your current list
To print out your current list, you may use either of two options: a long,
detailed output, and a short summary (ideal for status bars). The long-form
-output is read just by running Cras without any further options:
+output is read just by running Cras on your file without any further options:
```
-$ cras
+$ cras my-dev-todo
Tasks due for: Sat Jun 20 15:57:28 2020
#01 [TODO] Write README.md
@@ -53,7 +54,7 @@ Tasks due for: Sat Jun 20 15:57:28 2020
The short-form output is shown by using the -o option:
```
-$ cras -o
+$ cras -o my-dev-todo
3/0/3 to do/done/total
```
@@ -62,8 +63,8 @@ When you've completed a task, use -t and the task number (as shown by the
long-form output) to mark it as done.
```
-$ cras -t 2
-$ cras
+$ cras -t 2 my-dev-todo
+$ cras my-dev-todo
Tasks due for: Sat Jun 20 15:57:28 2020
#01 [TODO] Write README.md