Skip to content
This repository
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 61 lines (43 sloc) 1.411 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
= one_inch_punch

== DESCRIPTION:

one_inch_punch is meant as a generally data- and interface-compatible alternative
to Ara T. Howard's punch gem. The main benefits will be greater understandability,
test coverage, and usage outside of merely command-line situations.

Punch: Good enough
One-inch punch: Smaller, more effective

== FEATURES/PROBLEMS:

* Can load and write .punch.yml data compatibly with Ara's punch gem
* Can punch in and out of projects (including creating a project by punching in)
* Can query project status
* Can delete a project
* Can list project data
* Can give total time for a project
* Can be used command-line

* Command-line does not give access to the list operation
* Command-line output is ugly
* More, since this is unfinished

== SYNOPSIS:

  require 'punch'
  
  Punch.load
  Punch.status('my project') # => 'out'
  Punch.in('my project')
  Punch.status('my project') # => 'in'
  # do some work
  Punch.out('my project')
  Punch.out?('my project') # => true
  Punch.write
  
  or!
  
  $ punch in proj
  $ echo 'working, really'
  $ punch out proj
  $ punch status

== REQUIREMENTS:

* A reason to track time
* Ruby

== INSTALL:

* gem install one_inch_punch

== THANKS:

  * Ara T. Howard, for making punch in the first place
  * Kevin Barnes, for the name suggestion
  * Bruce Lee, for having been a bad-ass
  * The Kool-Aid Man, for busting through my wall. Oh yeah!
Something went wrong with that request. Please try again.