summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2022-11-21 10:10:03 +0200
committerYuval Adam <_@yuv.al>2022-11-21 10:10:03 +0200
commitcf3280e780cc63d278532b46fef6b1f798b9d34e (patch)
treec903c0725150b3836d381bc93220dfd4326f613b
parent137301a0cb2c5dc9465ae5afc36ff50bda6f447f (diff)
Update README with candidates
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
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.