diff --git a/README.md b/README.md index d28e75f..ad8b0bb 100644 --- a/README.md +++ b/README.md @@ -1,95 +1,14 @@ # xoxys.scan2mail - -[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.scan2mail/status.svg)](https://drone.rknet.org/ansible/xoxys.scan2mail) + +[![Build Status](https://img.shields.io/drone/build/ansible/xoxys.scan2mail?logo=drone&server=https%3A%2F%2Fdrone.rknet.org)](https://drone.rknet.org/ansible/xoxys.scan2mail) Setup scan2mail service -## Table of content +### License -* [Default Variables](#default-variables) - * [scan2mail_from_address](#scan2mail_from_address) - * [scan2mail_incron_jobs](#scan2mail_incron_jobs) - * [scan2mail_incron_system_table_dir](#scan2mail_incron_system_table_dir) - * [scan2mail_mail_domain](#scan2mail_mail_domain) - * [scan2mail_packages_extra](#scan2mail_packages_extra) - * [scan2mail_subject](#scan2mail_subject) -* [Dependencies](#dependencies) -* [License](#license) -* [Author](#author) +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. ---- +### Maintainers and Contributors -## Default Variables - -### scan2mail_from_address - -#### Default value - -```YAML -scan2mail_from_address: printer@{{ scan2mail_mail_domain }} -``` - -### scan2mail_incron_jobs - -#### Default value - -```YAML -scan2mail_incron_jobs: [] -``` - -#### Example usage - -```YAML -scan2mail_incron_jobs: - - path: /path/to/scan/dir - mask: IN_CREATE - action: scan2mail - options: - - $@ - - $ -``` - -### scan2mail_incron_system_table_dir - -#### Default value - -```YAML -scan2mail_incron_system_table_dir: /etc/incron.d -``` - -### scan2mail_mail_domain - -#### Default value - -```YAML -scan2mail_mail_domain: example.com -``` - -### scan2mail_packages_extra - -#### Default value - -```YAML -scan2mail_packages_extra: [] -``` - -### scan2mail_subject - -#### Default value - -```YAML -scan2mail_subject: Scan2Mail attachments -``` - -## Dependencies - -None. - -## License - -MIT - -## Author - -[xoxys](https://gitea.rknet.org/xoxys) +[Robert Kaussow](https://gitea.rknet.org/xoxys)