updated README.md to be a little more useful
parent
c3851346ce
commit
a26aa06c26
49
README.md
49
README.md
|
@ -1,27 +1,38 @@
|
||||||
# rodo
|
# rodo
|
||||||
A command-line todo list in Racket
|
A command-line todo list in Racket
|
||||||
|
|
||||||
* `init`--> initializes a file in ~/.rodo/todo-list
|
## Commands
|
||||||
|
|
||||||
|
### `init`
|
||||||
|
Initializes a file in *~/.rodo/todo-list*
|
||||||
|
|
||||||
|
**Example:**
|
||||||
|
`$ rodo init`
|
||||||
|
|
||||||
|
### `ls`
|
||||||
|
Lists items from the list
|
||||||
|
|
||||||
Example: `rodo init`
|
**Example:**
|
||||||
|
`$ rodo rm 1`
|
||||||
|
|
||||||
* `ls`--> lists items on the list
|
### `add`
|
||||||
|
Adds an item to the list
|
||||||
|
|
||||||
|
**Example:**
|
||||||
|
`$ rodo add bread`
|
||||||
|
|
||||||
|
**Note:**
|
||||||
|
For multi-word items you will need to surround your item in double quotes like this:
|
||||||
|
`$ rodo add "go to the bank"`
|
||||||
|
|
||||||
|
### `rm`
|
||||||
|
Removes an item from the list
|
||||||
|
|
||||||
Example: `rodo rm 1`
|
**Example:**
|
||||||
|
`$ rodo rm 1`
|
||||||
|
|
||||||
* `add`--> adds an item to the list
|
**Note:**
|
||||||
|
You may have to run `rodo ls` to see which number corresponds to which item to remove it.
|
||||||
|
|
||||||
Example: `rodo add bread`
|
## Configure rodo
|
||||||
|
Right now, the configurations can be found in the `config.rkt` file. Settings such at program name, path, and directory can be set here.
|
||||||
Note: For multi-word items you will need to
|
|
||||||
surround your item in double quotes like this:
|
|
||||||
|
|
||||||
`rodo add "go to the bank"`
|
|
||||||
|
|
||||||
* `rm`--> removes an item from the list
|
|
||||||
|
|
||||||
Example: `rodo rm 1`
|
|
||||||
|
|
||||||
Note: You may have to run `rodo ls` to see which
|
|
||||||
number corresponds to which item to remove it.
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue