From cf3280e780cc63d278532b46fef6b1f798b9d34e Mon Sep 17 00:00:00 2001
From: Yuval Adam <_@yuv.al>
Date: Mon, 21 Nov 2022 10:10:03 +0200
Subject: Update README with candidates

---
 README.md | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 105fc0b..9658a3a 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,7 @@ If your domain name is `examp.le` the file name should be `example.yml`, and the
 ```yaml
 domain: examp.le
 name: Example Foo
+title: A short title describing Example # maximum 80 chars
 ```
 
 Other optional fields are supported:
@@ -23,12 +24,15 @@ Other optional fields are supported:
 ```yaml
 domain: examp.le
 name: Example Foo
-url: https://examp.le/about/ # use to specify homepage URL, defaults to https://examp.le
 title: UI/UX designer # maximum 80 chars
+url: https://examp.le/about/ # use to specify homepage URL, defaults to https://examp.le
 email: hi@examp.le
 github: examplefoo
+candidate: true
 ```
 
+Candidates are links to users who have not yet explicitly added their `name` and `title` to the list.
+
 ## Development
 
 Local development requires a basic Python environment with [pipenv](https://pipenv.pypa.io/en/latest/) installed.
-- 
cgit v1.3.1