Skip to content

Commit

Permalink
update readme and help
Browse files Browse the repository at this point in the history
  • Loading branch information
ctcpip committed Aug 1, 2016
1 parent 932005f commit 7071738
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

a simple timer for the console/terminal

![Version 1.1.0](https://img.shields.io/badge/version-1.1.0-blue.svg)
[![Build Status](https://img.shields.io/travis/ctcpip/timezilla.svg)](http://travis-ci.org/ctcpip/timezilla)
[![Code Climate](https://img.shields.io/codeclimate/github/ctcpip/timezilla.svg)](https://codeclimate.com/github/ctcpip/timezilla)
[![Issue Count](https://img.shields.io/codeclimate/issues/github/ctcpip/timezilla.svg)](https://codeclimate.com/github/ctcpip/timezilla/issues)
Expand All @@ -15,8 +16,10 @@ a simple timer for the console/terminal
1. the terminal bell will ring _(every 30 seconds)_
1. a desktop notification is sent _(only for the following operating systems*)_
* __GNU/Linux__ using _libnotify_ `notify-send`
* copy [clock.png](http://github.com/ctcpip/timezilla/blob/master/clock.png) into the application directory to display a clock icon in the notification
* __OS X 10.9+__ using _AppleScript_ `display notification`
* use CTRL+C to exit
* P to pause
* CTRL+C to exit

\*see [notifize](http://github.com/ctcpip/notifize) package for more information on desktop notification support for other operating systems

Expand Down Expand Up @@ -44,7 +47,7 @@ timezilla 10.1 # 10 minute, six second timer

### inspiration

I started this project to provide a simple timer for use with the [pomodoro technique](http://en.wikipedia.org/wiki/Pomodoro_Technique), a time management method.
I started this project to provide a simple timer for use with the [pomodoro technique](http://en.wikipedia.org/wiki/Pomodoro_Technique), a time management method. this application is written in Go / golang.

### stuff nobody cares about

Expand Down
23 changes: 10 additions & 13 deletions static.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ package main

import "fmt"

const version = "1.0.0"
const version = "1.1.0"

var strHeader = fmt.Sprintf("timezilla %s (C) 2016 Chris de Almeida \"timezilla -h\" for more info", version)

Expand All @@ -37,17 +37,14 @@ usage: timezilla [minutes]
minutes specified in fractional minutes
if no minutes specified, timer will default to 25 minutes (pomodoro standard)
timezilla # default 25 minute timer
timezilla .5 # 30 second timer
timezilla 2.5 # 2 minute, 30 second timer
timezilla 5 # 5 minute timer
timezilla 10.1 # 10 minute, six second timer
-the timer will count down from the specified time
-when the time is up, three things happen:
1. an OS notification is sent (using libnotify or growl)
2. the terminal screen will flash red on/off
3. the terminal bell will ring
-use CTRL+C to exit
timezilla # default 25 minute timer
timezilla .5 # 30 second timer
timezilla 1 # 1 minute timer
timezilla 2.5 # 2 minute, 30 second timer
timezilla 5 # 5 minute timer
timezilla 10.1 # 10 minute, six second timer
see http://github.com/ctcpip/timezilla for more usage details
`, version)

0 comments on commit 7071738

Please sign in to comment.