diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 69 |
1 files changed, 8 insertions, 61 deletions
@@ -4,71 +4,18 @@ Todolist is a simple and very fast task manager for the command line. It is bas [gtd]: http://lifehacker.com/productivity-101-a-primer-to-the-getting-things-done-1551880955 -## Installation +## Documentation -Grab the binary that makes sense for your platform: +See [The main Todolist website](tdl) for the current documentation. -## Usage +[tdl]: https://gammons.github.io/todolist -Todolist looks for a `.todos.json` file in the current directory you are in. +## Is it good? -The first command you will want to run is `todo init`. +Yes. Yes it is. -``` -~ todo init -Todo repo initialized. -``` +## Author -#### Adding todos +Please send complaints, complements, rants, etc to [Grant Ammons](ga) -Adding todos is as simple as using the `add` or `a` command. - -```bash -~ todo add Talk with @bob about the +devopsProject due tuesday -Todo added. -``` - -**Projects and Contexts** - -When you add a todo, you can add one or more `+project`s or `@context`s, which you can use for grouping or filtering. - -``` -~ todo a Did @mary talk with @bob about the +devopsProject? due tod -Todo added. -``` - -**Dates** - -You can also add a due date by adding `due <date>` at the end. Below is a list of phrases that `due` can recognize: - -* `due today` or `due tod` -* `due tomorrow` or `due tom` - -* `due (monday|tuesday|wednesday|thursday|friday|saturday|sunday)` -* `due (mon|tue|wed|thur|fri|sat|sun)` - -Sets the due date to be a specific day of this or next week, depending on what day it is. - -For example, if today is a Tuesday: - -* `todo a chat with @nick due wed` will be the very next day. -* `todo a chat with @nick due mon` will be the *following* Monday. - -You can also use specific dates, provided the are in the format of `jan 2` or `2 jan`. - -* `todo a chat with @nick due may 15` -* `todo a chat with @nick due 15 may` - -#### Listing todos - -Listing todos outputs a nice formatted list. - -**`todo list`** - -This will list all unarchived todos. - -## FAQ - -**Really? Another task manager?** - -I wrote todolist because I basically wanted to be able to grep my todos easily. Also, while Wunderlist is fantastic, managing todos is something that is easily done on the command line. +[ga]: https://twitter.com/gammons |