updated README.md to be a little more useful
parent
c4e837b533
commit
91c8def7e9
14
README.md
14
README.md
|
@ -12,32 +12,30 @@ A command-line todo list in Racket
|
||||||
### `init`
|
### `init`
|
||||||
Initializes a file in *~/.rodo/todo-list*
|
Initializes a file in *~/.rodo/todo-list*
|
||||||
|
|
||||||
**Example:**
|
**Example:** `$ rodo init`
|
||||||
`$ rodo init`
|
|
||||||
|
|
||||||
### `ls`
|
### `ls`
|
||||||
Lists items from the list
|
Lists items from the list
|
||||||
|
|
||||||
**Example:**
|
**Example:** `$ rodo rm 1`
|
||||||
`$ rodo rm 1`
|
|
||||||
|
|
||||||
### `add`
|
### `add`
|
||||||
Adds an item to the list
|
Adds an item to the list
|
||||||
|
|
||||||
**Example:**
|
**Example:** `$ rodo add bread`
|
||||||
`$ rodo add bread`
|
|
||||||
|
|
||||||
**Note:**
|
**Note:**
|
||||||
|
|
||||||
For multi-word items you will need to surround your item in double quotes like this:
|
For multi-word items you will need to surround your item in double quotes like this:
|
||||||
`$ rodo add "go to the bank"`
|
`$ rodo add "go to the bank"`
|
||||||
|
|
||||||
### `rm`
|
### `rm`
|
||||||
Removes an item from the list
|
Removes an item from the list
|
||||||
|
|
||||||
**Example:**
|
**Example:** `$ rodo rm 1`
|
||||||
`$ rodo rm 1`
|
|
||||||
|
|
||||||
**Note:**
|
**Note:**
|
||||||
|
|
||||||
You may have to run `rodo ls` to see which number corresponds to which item to remove it.
|
You may have to run `rodo ls` to see which number corresponds to which item to remove it.
|
||||||
|
|
||||||
## Configure rodo
|
## Configure rodo
|
||||||
|
|
Loading…
Reference in New Issue