bin/tau: add example to README

bin/tau/README.md

@@ -72,25 +72,169 @@ connect to in the p2p network.
 
 	tau 0.3.0
 	Tau cli
-	
+
 	USAGE:
-	    tau [OPTIONS] [SUBCOMMAND]
-	
+		tau [FLAGS] [OPTIONS] [filters]... [SUBCOMMAND]
+
+	FLAGS:
+		-h, --help       Prints help information
+		-V, --version    Prints version information
+		-v               Increase verbosity
+
 	OPTIONS:
-	    -h, --help               Print help information
-	        --listen <LISTEN>    Rpc address [default: 127.0.0.1:8875]
-	    -v                       Increase verbosity
-	    -V, --version            Print version information
-	
+		-c, --config <config>     Sets a custom config file
+			--rpc <rpc-listen>    JSON-RPC listen URL [default: 127.0.0.1:11055]
+
+	ARGS:
+		<filters>...    Search criteria (zero or more)
+
 	SUBCOMMANDS:
-	    add            Add a new task
-	    get            Get task by ID
-	    get-comment    Get task's comments
-	    get-state      Get task state
-	    help           Print this message or the help of the given subcommand(s)
-	    list           List open tasks
-	    set-comment    Set comment for a task
-	    set-state      Set task state
-	    update         Update/Edit an existing task by ID
+		add            Add a new task
+		get            Get task by ID
+		get-comment    Get task's comments
+		get-state      Get task state
+		help           Prints this message or the help of the given subcommand(s)
+		list           List open tasks
+		set-comment    Set comment for a task
+		set-state      Set task state
+		update         Update/Edit an existing task by ID
+
+```shell
+% tau help [SUBCOMMAND]
+```
+
+### Add new tasks
+
+```shell
+% tau add title1 description person1,person2 project1,project2 0405 4.74
+% tau add title2 "some description" person1 project1 0805 18
+% # this will prompt terminal for title
+% tau add
+Title: new title
+% # then your system's default editor will open up and you could write some description
+% # you should have/add environment variable EDITOR pointing to your favorite text editor
+```
+for more information:
+```shell
+% tau add --help
+```
+
+
+### List existing tasks
+
+```shell
+% tau list # or just tau
+```
+Output:
+```text
+ ID | Title     | Project           | Assigned        | Due             | Rank 
+----+-----------+-------------------+-----------------+-----------------+------
+ 2  | title2    | project1          | person1         | Sunday 8 May    | 18 
+ 1  | title1    | project1,project2 | person1,person2 | Wednesday 4 May | 4.74 
+ 3  | new title |                   |                 |                 | 0 
+```
+
+
+### List tasks with filters
+
+```shell
+% tau all   		 # lists all tasks
+% tau open 			 # lists currently open tasks
+% tau pause 		 # lists currently paused tasks
+% tau month 		 # lists tasks created at this month
+% tau project:value  # lists all tasks that have "value" in their Project
+% tau assign:value   # lists all tasks that have "value" in their Assign
+% tau "rank>number"  # lists all tasks that have rank greater than "number"
+% tau "rank<number"  # lists all tasks that have rank lesser than "number"
+```
+
+Combined filters:
+```shell
+% tau project:project1 assign:person2 month open
+```
+Output:
+```text
+ ID | Title  | Project  | Assigned        | Due             | Rank 
+----+--------+----------+-----------------+-----------------+------
+ 1  | title1 | project1 | person1,person2 | Wednesday 4 May | 4.74 
+```
 
 
+### Update an existing task
+
+```shell
+% tau update 3 project project3 
+% tau "rank<4" # qoutes are for escaping special characters
+```
+Output:
+```text
+ ID | Title     | Project  | Assigned | Due | Rank 
+----+-----------+----------+----------+-----+------
+ 3  | new title | project3 |          |     | 0 
+```
+
+
+### Get/Set task state
+
+```shell
+% tau get-state 1 
+```
+Output:
+```text
+Task with id 1 is: "open"
+```
+
+```shell
+% tau set-state 1 pause
+% tau get-state 1 
+```
+Output:
+```text
+Task with id 1 is: "pause"
+```
+
+```shell
+% tau set-state 2 stop # this will deactivate the task (task is done)
+```
+
+
+### Get/Set comment
+
+```shell
+% tau set-comment 1 person1 "some awesome comment"
+% tau set-comment 1 person2 "other awesome comment"
+% tau get-comment 1
+```
+Output:
+```text
+Comments on Task with id 1:
+person1: some awesome comment
+person2: other awesome comment
+```
+
+
+### Get a task
+
+```shell
+% tau get 1
+```
+Output:
+```text
+ Name          | Value 
+---------------+--------------------------------
+ ref_id        | cGw1AI7cBSdJWIqPMU8d355wRrB0qy 
+ id            | 1 
+ title         | title1 
+ desc          | description 
+ assign        | person1,person2 
+ project       | project1 
+ due           | Wednesday 4 May 
+ rank          | 4.74 
+ created_at    | 21:28 Monday 2 May 
+ current_state | pause 
+ comments      | person1: some awesome comment 
+               | person2: other awesome comment 
+------------------------------------------------------
+ events  State changed to pause at 21:34 Monday 2 May 
+------------------------------------------------------
+```