Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

updated readme

  • Loading branch information...
commit 0a1c45857e8c4c4cbbdf29f10127bac5933143bf 1 parent 5b202bc
cloudhead authored
Showing with 48 additions and 14 deletions.
  1. +48 −14 README.md
View
62 README.md
@@ -3,9 +3,7 @@ koi
minimal task management for hackers.
- $ sudo gem install koi -s http://gemcutter.org
-
-_Note: this project is still under heavy development!_
+ $ sudo gem install koi
Synopsis
--------
@@ -25,22 +23,24 @@ Let's see what we've got now with `list`:
$ koi list
- [0] refactor spaghetti code
- [1] find a better name
+ [0] refactor spaghetti code
+ [1] find a better name
Tasks can be refered to by index `1`, `2` or by name. You don't have to type in the full name though:
- $ koi tag spaghetti #R
- $ koi done 1
+ $ koi tag spaghetti #food
+ $ koi did 1
-I just went ahead and tagged my first task with `#R`, and completed my 2nd one. Here's the new list:
+I just went ahead and tagged my first task with `#food`, and completed my 2nd one. Let's check our status by just typing `koi`:
- $ koi list
+ $ koi
+
+ [0] refactor spaghetti code #food
- [0] refactor spaghetti code #R
-
- # recently completed
- - find a better name
+ [x] find a better name
+
+The `status` command, also the default command when you just type `koi`, shows your top 5 tasks, as well as
+your recently completed tasks. As you can see, task `1` was completed, shown by an `x` instead of `1`.
You can also specify tags when adding new tasks:
@@ -49,8 +49,42 @@ You can also specify tags when adding new tasks:
And remove tasks:
$ koi remove pasta
+ $ koi kill 2
+
+As well as sticky tasks, with `+` or `float`:
+
+ $ koi + pasta
+ $ koi
+
+ [0] + make pasta #food #yum #kitchen
+ [1] refactor spaghetti code
+ [2] find a better name
+
+If you want to show all koi with a specific tag, you can use the `show` command:
+
+ $ koi show #yum
+
+ [0] cucumbers #yum
+ [1] pancakes #yum
+
+And if you want a log of all your activities, just try:
+
+ $ koi log
+
+Bumping tasks up or down
+------------------------
+
+To move koi up in the list, use `rise`:
+
+ $ koi rise 3
+
+To move koi down the list, use `sink`:
+
+ $ koi sink burgers
+
+Simple.
-**koi** creates an _.koi_ folder in the directory you initialize your project in. Inside that folder is a _database.yml_ with all your tasks for that project.
+**koi** creates a _.koi_ folder in the directory you initialize your project in. Inside that folder is a _database.yml_ with all your tasks for that project.
Please sign in to comment.
Something went wrong with that request. Please try again.