diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 56 |
1 files changed, 0 insertions, 56 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index 697c53e..0000000 --- a/README.md +++ /dev/null @@ -1,56 +0,0 @@ -# Domain Name Hack Club - -**https://namehack.club** - An exclusive club of geeks that own the domain hack to their name. - -## 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 - -## 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 `examp.le.yml`, and the following minimal fields are required: - -```yaml -domain: examp.le -name: Example Foo -title: A short title describing Example # maximum 80 chars -``` - -Other optional fields are supported: - -```yaml -domain: examp.le -name: Example Foo -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 [uv](https://docs.astral.sh/uv/) installed. - -```bash -$ uv sync --extra=dev -$ uv run build -$ uv run serve -``` - -Other commands are accessible via: - -```bash -$ uv run cli -``` - -Netlify build requires an updated `requirements.txt` file, if dependencies have changed, run: - -```bash -$ uv pip compile pyproject.toml -o requirements.txt -``` |