docs: add example

ismdeep · Apr 24, 2024 · 0b4b4a4 · 0b4b4a4
1 parent 88a154e
commit 0b4b4a4
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,18 @@
-# cron
+# cron
+
+# Quick Start
+
+docker-compose.yaml
+
+```
+services:
+  cron-service:
+    image: ismdeep/cron:latest
+    environment:
+      TZ: Asia/Shanghai
+      CRON_SPEC: '@every 1m'
+      CRON_COMMAND: 'date'
+      CRON_RUN_AT_START: true
+    restart: always
+```
+
diff --git a/example/docker-compose.yaml b/example/docker-compose.yaml
@@ -0,0 +1,9 @@
+services:
+  cron-service:
+    image: ismdeep/cron:latest
+    environment:
+      TZ: Asia/Shanghai
+      CRON_SPEC: '@every 1m'
+      CRON_COMMAND: 'date'
+      CRON_RUN_AT_START: true
+    restart: always