summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2022-10-23 12:31:09 +0300
committerYuval Adam <_@yuv.al>2022-10-23 12:31:27 +0300
commitf51b19622a0cbbcd394dc91845df0b52fe95fe68 (patch)
tree850dc6ed4a0b4c33b8c59840f5d07619d0f2200e
parent122c173861bd23efa1aa9222ce083bafe60fb693 (diff)
Join the club instructions
-rw-r--r--README.md18
1 files changed, 14 insertions, 4 deletions
diff --git a/README.md b/README.md
index 58223dc..4447658 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,20 @@
# namehack.club
-An exclusive club of nerds
+An exclusive club of nerds.
## Criteria
- Own the [domain hack](https://en.wikipedia.org/wiki/Domain_hack) for your name, e.g. [https://yuv.al](https://yuv.al)
-- Serve an active **personal** homepage from that domain
- - Both naked and subdomains (such as `www.`) are allowed
- - Redirects to other domains do not qualify
+- Serve an active **personal** homepage from that domain, both naked and subdomains (such as `www.`) are allowed
+
+## Join the club
+
+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:
+
+```yaml
+domain: examp.le
+name: Example Foo
+email: hi@examp.le
+``` \ No newline at end of file