Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Made a few README changes to improve rendered display (esp. on GitHub…

…), added

Installation section.

  * Added a newline above code (shell) sections so they'll be properly formatted
  * (they were being smooshed inline into the paragraph above).  Added bullets
  * to denote each example.  Put license in blockquote.  Wrote simplest
  * Installation instructions ever.
  • Loading branch information...
commit e37e9108c7ce763a12241a9a6f73ea26877b8ba0 1 parent 5c253dc
@jrunning jrunning authored
Showing with 110 additions and 89 deletions.
  1. +110 −89 Readme.md
View
199 Readme.md
@@ -9,6 +9,10 @@ command-line with a simple, slick interface. You are reminded of the remaining
time on a task via Growl. These notifications appear half-way, at the 5 minute point,
and when the task duration has expired.
+## Installation
+
+ $ gem install pomo
+
## Task Selection API
Taken from `pomo help`:
@@ -30,108 +34,125 @@ Taken from `pomo help`:
## Examples
-View global or command specific help:
- $ pomo help
- $ pomo help add
- $ pomo help remove
+ * View global or command specific help:
+
+ $ pomo help
+ $ pomo help add
+ $ pomo help remove
-Get started by adding a task:
- $ pomo add "Fix IE stying issues"
+ * Get started by adding a task:
+
+ $ pomo add "Fix IE stying issues"
-And another:
- $ pomo add "Destroy IE" --description "because IE is terrible"
+ And another:
+
+ $ pomo add "Destroy IE" --description "because IE is terrible"
-List your tasks (or use `pomo` which defaults to `pomo list`):
- $ pomo list
- 0. Fix IE stying issues : 25 minutes
- 1. Destroy IE : 25 minutes
-
-Start the first incomplete task:
- $ pomo start
- Started Fix IE stying issues, you have 25 minutes :)
- (=........................) 24 minutes remaining
+ * List your tasks (or use `pomo` which defaults to `pomo list`):
+
+ $ pomo list
+ 0. Fix IE stying issues : 25 minutes
+ 1. Destroy IE : 25 minutes
+
+ * Start the first incomplete task:
+
+ $ pomo start
+ Started Fix IE stying issues, you have 25 minutes :)
+ (=........................) 24 minutes remaining
-Once you have completed the task, list again:
- $ pomo list
- ✓ 0. Fix IE stying issues : 25 minutes
- 1. Destroy IE : 25 minutes
-
-Or take a break:
- $ pomo break
- $ pomo break 10
- $ pomo break --length 10
-
-List only remaining tasks:
- $ pomo list --incomplete
- 1. Destroy IE : 25 minutes
+ * Once you have completed the task, list again:
+
+ $ pomo list
+ ✓ 0. Fix IE stying issues : 25 minutes
+ 1. Destroy IE : 25 minutes
-List only completed tasks:
- $ pomo list --complete
- ✓ 0. Fix IE stying issues : 25 minutes
+ * Or take a break:
+
+ $ pomo break
+ $ pomo break 10
+ $ pomo break --length 10
-At any time mid-task you may terminate pomo via CTRL + C, at which time
-you may manually complete the task:
- $ pomo complete first
- $ pomo complete last
- $ pomo complete 1
- $ pomo complete all
- $ pomo complete incomplete
- $ pomo complete 5..7
+ * List only remaining tasks:
+
+ $ pomo list --incomplete
+ 1. Destroy IE : 25 minutes
-The next time you run `pomo start` the first incomplete task will start:
- $ pomo start
-
-Or choose a specific task:
- $ pomo start first
- $ pomo start last
- $ pomo start 5
+ * List only completed tasks:
+
+ $ pomo list --complete
+ ✓ 0. Fix IE stying issues : 25 minutes
+
+ * At any time mid-task you may terminate pomo via CTRL + C, at which
+ time you may manually complete the task:
+
+ $ pomo complete first
+ $ pomo complete last
+ $ pomo complete 1
+ $ pomo complete all
+ $ pomo complete incomplete
+ $ pomo complete 5..7
+
+ * The next time you run `pomo start` the first incomplete task
+ will start:
+
+ $ pomo start
-You may also remove tasks
- $ pomo remove first
- $ pomo remove last
- $ pomo remove 2
- $ pomo remove 1
- $ pomo remove 6
- $ pomo rm first
- $ pomo rm 2..5
- $ pomo rm 1..-1
+ Or choose a specific task:
+
+ $ pomo start first
+ $ pomo start last
+ $ pomo start 5
-View task details:
- $ pomo view first
- $ pomo view last
- $ pomo view 5
- $ pomo view 1 2 3
-
-Remove all tasks:
- $ pomo remove all
- $ pomo rm all
+ * You may also remove tasks:
+
+ $ pomo remove first
+ $ pomo remove last
+ $ pomo remove 2
+ $ pomo remove 1
+ $ pomo remove 6
+ $ pomo rm first
+ $ pomo rm 2..5
+ $ pomo rm 1..-1
-Or if you prefer, create a directory specific task list. Pomo will
-auto-detect _./.pomo_ in this directory, and utilize its contents.
- $ pomo init
+ * View task details:
-
-## License
+ $ pomo view first
+ $ pomo view last
+ $ pomo view 5
+ $ pomo view 1 2 3
-(The MIT License)
+ * Remove all tasks:
-Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>
+ $ pomo remove all
+ $ pomo rm all
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, an d/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+ * Or if you prefer, create a directory specific task list. Pomo will
+ auto-detect `./.pomo` in this directory, and utilize its contents.
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+ $ pomo init
+
+## License
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+> (The MIT License)
+>
+> Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>
+>
+> Permission is hereby granted, free of charge, to any person
+> obtaining a copy of this software and associated documentation files
+> (the 'Software'), to deal in the Software without restriction,
+> including without limitation the rights to use, copy, modify, merge,
+> publish, distribute, sublicense, an d/or sell copies of the
+> Software, and to permit persons to whom the Software is furnished to
+> do so, subject to the following conditions:
+>
+> The above copyright notice and this permission notice shall be
+> included in all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+> BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+> ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+> CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+> THE SOFTWARE.
Please sign in to comment.
Something went wrong with that request. Please try again.