add support for `email = false` to disable email validation

This allows a person to explicitly opt out from the mailing lists.

1 files changed, 2 insertions, 0 deletions

diff --git a/README.md b/README.md
index 9683997..b860b37 100644
--- a/README.md
+++ b/README.md
@@ -62,6 +62,8 @@ The file structure is this:
 ```toml
 name = "John Doe"  # Real name of the person (required)
 github = "johndoe"  # GitHub username of the person (required)
+# You can also set `email = false` to explicitly disable the email for the user.
+# This will, for example, avoid adding the person to the mailing lists.
 email = "john@doe.com"  # Email address used for mailing lists (optional)
 irc-nickname = "jdoe"  # Nickname of the person on IRC, if different than the GitHub one (optional)
 ```