Skip to content

Commit 7071738

Browse files
committed
update readme and help
1 parent 932005f commit 7071738

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
a simple timer for the console/terminal
44

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

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

@@ -44,7 +47,7 @@ timezilla 10.1 # 10 minute, six second timer
4447

4548
### inspiration
4649

47-
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.
50+
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.
4851

4952
### stuff nobody cares about
5053

static.go

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ package main
2424

2525
import "fmt"
2626

27-
const version = "1.0.0"
27+
const version = "1.1.0"
2828

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

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

0 commit comments

Comments
 (0)