From 99dfbc317d1e4cd36c6d4a88fb02a7750bcbbed1 Mon Sep 17 00:00:00 2001 From: m455 Date: Sat, 19 May 2018 22:17:25 -0400 Subject: [PATCH] updated READEME.md --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 37b5b45..1e1b59f 100755 --- a/README.md +++ b/README.md @@ -44,23 +44,28 @@ to ## Usage +The below examples assume that you have rodo set up in your +$PATH folder. If you don't, you would simply go to the +directory of the `rodo.rkt` file and use `./rodo ` +instead. + ### `init` -Initializes a file in *~/.rodo/todo-list* +Initializes a file in `~/.rodo/todo-list` by default -**Example:** `$ rodo init` +**Example:** `rodo init` ### `ls` Lists items from the list - **Example:** `$ rodo rm 1` + **Example:** `rodo rm 1` ### `add` Adds an item to the list -**Example:** `$ rodo add bread` +**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"` @@ -69,10 +74,10 @@ Adds an item to the list 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. -## Configure rodo +## Configuring 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.