From 0a128707db5c83fce6a43119c17409ac49dc7101 Mon Sep 17 00:00:00 2001 From: m455 Date: Wed, 18 Apr 2018 00:12:32 -0400 Subject: [PATCH] updated README.md to be a little more useful --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index aa486c1..ed667ec 100755 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # rodo + A command-line todo list in Racket ***Current bugs:*** @@ -10,33 +11,34 @@ A command-line todo list in Racket ## Commands ### `init` + Initializes a file in *~/.rodo/todo-list* **Example:** `$ rodo init` ### `ls` + Lists items from the list **Example:** `$ rodo rm 1` ### `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: +**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. +**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.