[SKIP CI] update readme

README.md

@@ -1,2 +1,165 @@
 # xoxys.yum
   
+[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.yum/status.svg)](https://drone.rknet.org/ansible/xoxys.yum)
+
+
+Setup yum cron and yum repositories
+
+## Table of content
+
+* [Default Variables](#default-variables)
+  * [yum_cron_enabled](#yum_cron_enabled)
+  * [yum_cron_custom_cronjob](#yum_cron_custom_cronjob)
+  * [yum_cron_apply_updates](#yum_cron_apply_updates)
+  * [yum_cron_download_updates](#yum_cron_download_updates)
+  * [yum_cron_email_from](#yum_cron_email_from)
+  * [yum_cron_email_to](#yum_cron_email_to)
+  * [yum_cron_emit_via](#yum_cron_emit_via)
+  * [yum_cron_random_sleep](#yum_cron_random_sleep)
+  * [yum_repositories](#yum_repositories)
+  * [yum_upgrade_enabled](#yum_upgrade_enabled)
+  * [yum_packages_install](#yum_packages_install)
+  * [yum_packages_uninstall](#yum_packages_uninstall)
+  * [yum_packages_extra_install](#yum_packages_extra_install)
+* [Dependencies](#dependencies)
+* [License](#license)
+* [Author](#author)
+
+---
+
+## Default Variables
+
+### yum_cron_enabled
+
+#### Default value
+
+```YAML
+yum_cron_enabled: true
+```
+
+### yum_cron_custom_cronjob
+
+#### Default value
+
+```YAML
+yum_cron_custom_cronjob:
+  enabled: false
+  name: yum-cron
+  minute: 0
+  hour: 4
+  day: '*'
+  weekday: '*'
+  month: '*'
+```
+
+### yum_cron_apply_updates
+
+#### Default value
+
+```YAML
+yum_cron_apply_updates: no
+```
+
+### yum_cron_download_updates
+
+#### Default value
+
+```YAML
+yum_cron_download_updates: yes
+```
+
+### yum_cron_email_from
+
+#### Default value
+
+```YAML
+yum_cron_email_from: root@localhost
+```
+
+### yum_cron_email_to
+
+#### Default value
+
+```YAML
+yum_cron_email_to: root
+```
+
+### yum_cron_emit_via
+
+#### Default value
+
+```YAML
+yum_cron_emit_via: stdio
+```
+
+### yum_cron_random_sleep
+
+#### Default value
+
+```YAML
+yum_cron_random_sleep: 360
+```
+
+### yum_repositories
+
+#### Default value
+
+```YAML
+yum_repositories: []
+```
+
+#### Example usage
+
+```YAML
+yum_repositories:
+  - name: epel
+    filename: Extra-EPEL
+    desc: Extra Packages for Enterprise Linux (EPEL)
+    baseurl: "http://download.fedoraproject.org/pub/epel/$releasever/$basearch/"
+    gpgkey: "http://download.fedoraproject.org/pub/epel/RPM-GPG-KEY-EPEL-$releasever/"
+    enabled: True
+```
+
+### yum_upgrade_enabled
+
+#### Default value
+
+```YAML
+yum_upgrade_enabled: false
+```
+
+### yum_packages_install
+
+#### Default value
+
+```YAML
+yum_packages_install: []
+```
+
+### yum_packages_uninstall
+
+#### Default value
+
+```YAML
+yum_packages_uninstall: []
+```
+
+### yum_packages_extra_install
+
+#### Default value
+
+```YAML
+yum_packages_extra_install: []
+```
+
+## Dependencies
+
+None.
+
+## License
+
+MIT
+
+## Author
+
+xoxys