diff --git a/README.md b/README.md index 4149fbf..ecab0cd 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ # Postfix Sendgrid -[![CI](https://github.com/jobscore/ansible-role-postfix-sendgrid/actions/workflows/ci.yml/badge.svg)](https://github.com/jobscore/ansible-role-postfix-sendgrid/actions/workflows/ci.yml) +[![CI](https://github.com/jobscore/ansible-role-postfix-sendgrid/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/jobscore/ansible-role-postfix-sendgrid/actions/workflows/ci.yml) Ansible Role for configuring Postfix as a Sendgrid relay on Ubuntu -## Requirements - -TBD - ## Role Variables -TBD +``` +postfix_mailname: The hostname to be used by Postfix +sendgrid_user: Your username from Sendgrid. You can use `apikey` as the username if using API keys (recommended) +sendgrid_password: Your password (or API key) from Sendgrid +``` ## Example Playbooks @@ -22,7 +22,6 @@ TBD ## License - [MIT](/LICENSE) Author Information