summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2022-11-26 09:51:17 +0200
committerGitHub <noreply@github.com>2022-11-26 09:51:17 +0200
commit7387c7cb3ef89c0227b53a19a8057c35e6aec6e9 (patch)
tree7f2cf28cf070aab45266b9950dd7e9b64eb61666 /README.md
parent6d40823ded0bed7c32ebd9747d261f03b09b6893 (diff)
parent76583e5aca961cc68eb6d3f8438b1a7d113b1c14 (diff)
Merge pull request #57 from yuvadm/candidates
Add mass of candidates
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/README.md b/README.md
index 105fc0b..e9fd209 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# Domain Name Hack Club
-**https://namehack.club** - An exclusive club of nerds that own the domain hack to their name.
+**https://namehack.club** - An exclusive club of geeks that own the domain hack to their name.
## Criteria
@@ -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.