diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 55 |
1 files changed, 54 insertions, 1 deletions
@@ -1 +1,54 @@ -# namehack.club
\ No newline at end of file +# 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 [`src/content/names`](src/content/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 [Node.js](https://nodejs.org/) and npm installed. + +```bash +$ npm install +$ npm run dev +``` + +Other available commands: + +```bash +$ npm run build # Build for production +$ npm run preview # Preview production build locally +``` + +## Deployment + +Handled automagically on Cloudflare. |