Skip to content

Commit

Permalink
Updated README with usage of ogrodnek's changes
Browse files Browse the repository at this point in the history
  • Loading branch information
ErikBjare committed Jan 28, 2014
1 parent feb5720 commit 6b5b057
Showing 1 changed file with 28 additions and 13 deletions.
41 changes: 28 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
#Streak
Streak is a command-line productivity tool based around the "Seinfeld method"

[Seinfeld] revealed a unique calendar system he uses to pressure
himself to write. Here's how it works.
> [Seinfeld](https://en.wikipedia.org/wiki/Jerry_Seinfeld) revealed a unique calendar system he uses to pressure
himself to write. Here's how it works.

He told me to get a big wall calendar that has a whole year on one page
and hang it on a prominent wall. The next step was to get a big red
magic marker.
> He told me to get a big wall calendar that has a whole year on one page
and hang it on a prominent wall. The next step was to get a big red
magic marker.

He said for each day that I do my task of writing, I get to put a big
red X over that day. "After a few days you'll have a chain. Just keep
at it and the chain will grow longer every day. You'll like seeing that
chain, especially when you get a few weeks under your belt. Your only
job next is to not break the chain."
> He said for each day that I do my task of writing, I get to put a big
red X over that day. "After a few days you'll have a chain. Just keep
at it and the chain will grow longer every day. You'll like seeing that
chain, especially when you get a few weeks under your belt. Your only
job next is to not break the chain."

"Don't break the chain," he said again for emphasis.
> "Don't break the chain," he said again for emphasis.
http://lifehacker.com/281626/jerry-seinfelds-productivity-secret
> **Source:** http://lifehacker.com/281626/jerry-seinfelds-productivity-secret
Streak uses the Google Calendar API to maintain a calendar named "Streaks"
(that you must create yourself). The calendar consists of multi-day entries
Expand All @@ -24,15 +25,29 @@ idea is that you run this tool every day whenever you've done the thing that
you're trying to push yourself to do. Then whenever you look at your Google
Calendar you'll see your streaks and feel proud/ashamed of yourself.

Sample invocations:
##Usage
Usage: streak [OPTION...]
-cachefile="/home/erb/.streak-request-token": Authentication token cache file
-cal="Streaks": Streak calendar name
-create=false: Create calendar if missing
-event="Streak": Streak event name
-offset=0: Day offset
-remove: Remove day from streak

###Examples:

streak
Add today to a streak (or create a streak if none exists).
streak -create
Add today to a streak using default calendar "Streaks", creates the calendar first if missing.
streak -remove
Remove today from a streak.
streak -offset -1
Add yesterday to a streak (or create if none exists).
streak -offset -1 -remove
Remove yesterday from a streak
streak -cal="Streaks Test" -create
Add today to a streak in calendar "Streaks Example", creates the calendar first if missing.

-----
Andrew Gerrand <adg@golang.org>

0 comments on commit 6b5b057

Please sign in to comment.