Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kylek29 authored May 5, 2018
1 parent 79a8ff2 commit 0b49c1d
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Timer Object for Python to easily track duration. Made for a wider project as a

The class stores the UNIX time (in seconds) at time of being called with .start() method (not initialization) and will give back the current time since then when prompted (duration). Usage case scenario would be if you're doing a lot of timers for a RaspberryPI script (e.g. LED) and don't want to use sleep delays.

Includes a pause ability with the .stop() method. If you .start() a timer and then .stop() it (without destroying object or using the reset method), then .start() it again and .stop() it again, the time reported is the SUM of all the intervals.

If you want a singular timer object that can be started and stopped (paused) linearly, just use one timer object. If you need
multiple timers that have differing start/stops (overlapping), create multiple objects, like:
timer_A = Timer()
Expand Down

0 comments on commit 0b49c1d

Please sign in to comment.