summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2022-10-25 09:20:15 +0300
committerYuval Adam <_@yuv.al>2022-10-25 09:20:15 +0300
commit1d3ad68adae42f05ddd68c1b5183a8db5f2be338 (patch)
treef9c0cbf1991f068a1926a47118e68d60e0114fad /README.md
parent8d9f33a16c09e9c7ec5d37aad638ce80b0b5044e (diff)
Add support for extra optional fields
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 12 insertions, 3 deletions
diff --git a/README.md b/README.md
index 4447658..d52c08a 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# namehack.club
-An exclusive club of nerds.
+An exclusive club of nerds that own the domain hack to their name.
## Criteria
@@ -11,10 +11,19 @@ An exclusive club of nerds.
Open a new pull request to this repository that adds a new YAML file to the [`names`](names) directory.
-If your domain name is `examp.le` the file name should be `example.yml`, and should include the following required fields:
+If your domain name is `examp.le` the file name should be `example.yml`, and the following minimal fields are required:
```yaml
domain: examp.le
name: Example Foo
+```
+
+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
email: hi@examp.le
-``` \ No newline at end of file
+```