Add a README

1 files changed, 30 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..17d69dc
--- /dev/null
+++ b/README
@@ -0,0 +1,30 @@
+README for desktop-cronish
+==========================
+
+`desktop-cronish` is a small utility that runs jobs periodically.
+It differs from cron in that you're expected to run it from within
+a desktop login session, by opening a terminal and running it from
+the command line. This allows it to have access to things like
+SSH agents, which cronjobs do not have.
+
+As an example, I use it to run offlineimap, with offlinemap
+configured to get the IMAP password from the GNOME Keyring.
+
+Legalese
+--------
+
+Copyright 2013  Lars Wirzenius
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+