updated README.md to be a little more useful

main
m455 2018-04-18 00:04:10 -04:00
parent c3851346ce
commit a26aa06c26
1 changed files with 30 additions and 19 deletions

View File

@ -1,27 +1,38 @@
# rodo
A command-line todo list in Racket
* `init`--> initializes a file in ~/.rodo/todo-list
## Commands
Example: `rodo init`
### `init`
Initializes a file in *~/.rodo/todo-list*
* `ls`--> lists items on the list
**Example:**
`$ rodo init`
Example: `rodo rm 1`
### `ls`
Lists items from the list
* `add`--> adds an item to the list
**Example:**
`$ rodo rm 1`
Example: `rodo add bread`
### `add`
Adds an item to the list
Note: For multi-word items you will need to
surround your item in double quotes like this:
**Example:**
`$ rodo add bread`
`rodo add "go to the bank"`
**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
### `rm`
Removes an item from the list
Example: `rodo rm 1`
**Example:**
`$ rodo rm 1`
Note: You may have to run `rodo ls` to see which
number corresponds to which item to remove it.
**Note:**
You may have to run `rodo ls` to see which number corresponds to which item to remove it.
## 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.