From 5caf66ee781e53621a6d7599107beb7de8f0b575 Mon Sep 17 00:00:00 2001
From: Knut Ahlers <knut@ahlers.me>
Date: Fri, 26 Feb 2016 22:31:51 +0100
Subject: [PATCH] Added README

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..36104b4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+# Luzifer / rsyslog\_cron
+
+This project is a quick and dirty replacement for running a cron daemon inside docker containers.
+
+## Advantages
+
+- It logs the output of the jobs into a remote syslog target (like Papertrail) using TCP syslog
+- Crons can be started on seconds, not only on minutes like a conventional cron
+- Due to the logs cron jobs can get debugged
+
+## Usage
+
+1. Put the [binary](https://gobuilder.me/get/github.com/Luzifer/rsyslog_cron/rsyslog_cron_master_linux-amd64) into your container
+2. Generate a YAML file containing the cron definition
+3. Watch your crons get executed in your log stream
+
+## Config format
+
+```yaml
+---
+rsyslog_target: logs.myserver.com:12345
+jobs:
+  - name: date
+    schedule: "0 * * * * *"
+    cmd: "/bin/date"
+    args:
+      - "+%+"
+```
+
+The `rsyslog_target` parameter needs to be a rsyslog endpoint supporting TCP plain connections like Loggly or Papertrail does.
+
+The `schedule` parameter consists of 6 instead of the normal 5 fields:
+
+```
+field         allowed values
+-----         --------------
+second        0-59
+minute        0-59
+hour          0-23
+day of month  1-31
+month         1-12 (or names, see below)
+day of week   0-7 (0 or 7 is Sun, or use names)
+```
+
+Standard format for crontab entries is supported. (See `man 5 crontab`)