diff --git a/README.md b/README.md index 0390f13..255a797 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,48 @@ # Line[Tasker]: A pretty and simple project-scope TODO list in command line. -## Features: - -- Create new task: +## I - Create a new task +```shell +$ linetasker new "Finish writing unit tests" +``` +### I.2 - Priority and tags ```shell -$ linetasker new "This is a task to do" -p 4 +$ linetasker new "Finish writing unit tests" -p 5 --tags urgent --tags production --tags CI ``` -> `-p` : Priority of the task +> `-p` / `--priority`: priority of the task 1 -> 5 [1 by default] + +> `-t`/ --`tags`: add tags to the task -- List tasks: +## II - List tasks ```shell $ linetasker list ``` +![Alt text](assets/list.png) +### II.2 - Filtering -![linetasker list](./imgs/list.png) +```shell +$ linetasker list -n 9 -t production +``` +> `-n`: number of the tasks to display from the top +> `-t`: filter by tags +![Alt text](assets/list_filtered.png) -- Mark task as done +## III - Mark as done +```shell +$ linetasker done +``` +> `ID`: integer -- Delete a task +## IV - Delete task(s) +### IV.1 Delete one task +``` +$ linetasker del +``` +### IV.2 - Delete all done tasks +``` +$ linetasker clean +``` +### IV.3 - Clear all tasks +``` +$ linetasker reset -y +``` +> `-y`: flag for bypassing confirmation prompt diff --git a/assets/list.png b/assets/list.png new file mode 100644 index 0000000..c951c73 Binary files /dev/null and b/assets/list.png differ diff --git a/assets/list_filtered.png b/assets/list_filtered.png new file mode 100644 index 0000000..27950b1 Binary files /dev/null and b/assets/list_filtered.png differ diff --git a/imgs/list.png b/imgs/list.png deleted file mode 100644 index b7bfbf3..0000000 Binary files a/imgs/list.png and /dev/null differ