From fba4e92a69ab96b86300ce0d8368ea580235247d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Patrick=20L=C3=BChne?= <patrick@luehne.de>
Date: Sat, 4 Nov 2017 01:40:02 +0100
Subject: [PATCH] Add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6b0e12e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# nextcloud-background-job
+
+>  Regularly performs Nextcloud’s `cron.php` background job
+
+## Overview
+
+This package provides a `systemd` timer that executes Nextcloud’s `cron.php` background job every 15&nbsp;minutes.
+
+## Usage
+
+Enable and start the timer:
+
+```sh
+sudo systemctl enable nextcloud-background-job.timer
+sudo systemctl start nextcloud-background-job.timer
+```
+
+## Sources
+
+- [NextCloud documentation](https://docs.nextcloud.com/server/12/admin_manual/configuration_server/background_jobs_configuration.html)