Add doc comment for the program

1 files changed, 13 insertions, 0 deletions

diff --git a/main.go b/main.go
index 80aa62f..097f7bd 100644
--- a/main.go
+++ b/main.go
@@ -1,3 +1,16 @@
+// This program creates tasks in Todoist, based on time specificiations in the
+// cron format. It takes one argument (the path to the input file) and requires
+// that your Todoist developer token be set in the TODOIST_TOKEN environment
+// variable.
+//
+// The input file must be a text file where each line is either empty, a comment
+// (starting with #), or a cron specification followed by the name of the task.
+// Note that the cron specification must be provided as five whitespace
+// separated fields; this program doesn't currently support all the features of
+// robfig/cron (e.g. '@monthly').
+//
+// The input file is checked for changes each minute, and the program creates
+// Todoist tasks when their cron run time occurs.
 package main
 
 import (