Skip to content

Commit

Permalink
Update Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kucukaslan committed Nov 14, 2021
1 parent c08081a commit 0775656
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,18 @@
the todo is a command line application that allows you to add, delete, and mark items as complete.

## Features and Flags
The data is stored in a json file to persist between sessions.
- The data is stored in a json file to persist between sessions.
- Each item is associated with the date added to the list. The `-l` flag
also display how much time has been passed since the item added to the list
The following is the list of the flags and their functionalities.
todo -h # help
todo -v # version
todo -l # list all items (un-completed)
todo -c # list completed items
todo -a "Buy Milk" # add new item
todo -m TODO-ID # mark as complete
todo -um TODO-ID # mark as incomplete (unmark)
todo -d TODO-ID # delete item
todo -h # help
todo -v # version
todo -l # list all items (un-completed)
todo -c # list completed items
todo -a "Buy Milk" # add new item
todo -m TODO-ID # mark as complete
todo -um TODO-ID # mark as incomplete (unmark)
todo -d TODO-ID # delete item


## Installation
Expand All @@ -27,8 +29,8 @@ which is obtained by [UserConfigDir](https://pkg.go.dev/os#UserConfigDir)
Download the source code.
Open the directory.
Install the application with `go install todo`.
If the command is not installed try building the `go build .`
and copy the executable to `/usr/local/bin/` directory with the `cp todo /usr/local/bin/`.
If the command is not installed try building executable with the `go build .` command
and copy the executable to `/usr/local/bin/` directory with the `cp todo /usr/local/bin/` command.

The data is stored in the `$XDG_CONFIG_HOME/todo/.todo.json`,
which is obtained by [UserConfigDir](https://pkg.go.dev/os#UserConfigDir)

0 comments on commit 0775656

Please sign in to comment.