Files
is-a-dev/README.md
T
William Harrison 5e81e05f4b Update README.md
2024-12-31 19:31:14 +08:00

59 lines
3.8 KiB
Markdown

<p align="center">
<img alt="is-a.dev Banner" src="https://raw.githubusercontent.com/is-a-dev/register/main/media/banner.png">
</p>
<p align="center">
<img alt="Domains" src="https://img.shields.io/github/directory-file-count/is-a-dev/register/domains?color=5c46eb&label=domains&style=for-the-badge">
<img alt="Open Pull Requests" src="https://img.shields.io/github/issues-raw/is-a-dev/register?color=5c46eb&label=issues&style=for-the-badge">
<img alt="Open Issues" src="https://img.shields.io/github/issues-pr-raw/is-a-dev/register?color=5c46eb&label=pull%20requests&style=for-the-badge">
<br>
<img alt="Publish" src="https://github.com/is-a-dev/register/actions/workflows/publish.yml/badge.svg">
</p>
<h1 align="center">is-a.dev</h1>
<p align="center"><strong>is-a-dev</strong> is a service that allows developers to get a sweet-looking ".is-a.dev" domain for their personal websites.</p>
## Announcements & Status Updates
Please join our [Discord server](https://discord.gg/is-a-dev-830872854677422150) for announcements, updates & upgrades, and downtimes regarding the service.
Not all of these will be posted on GitHub, however they will always be posted in our Discord server.
<a href="https://discord.gg/is-a-dev-830872854677422150"><img alt="Discord Server" src="https://invidget.wdh.app/is-a-dev-830872854677422150"></a>
# Register
## How to Register
> If you want a more visual guide, check out [this blog post](https://wdh.gg/tX3ghge).
- [Fork](https://github.com/is-a-dev/register/fork) and star this repository
- Add a new file called `your-domain-name.json` in the `domains` folder to register `your-domain-name.is-a.dev`
- [Read the documentation](https://is-a.dev/docs)
- If you are applying for NS records please read [this](#ns-records).
- Your pull request will be reviewed and merged. *Make sure to keep an eye on it incase we need you to make any changes!*
- After the pull request is merged, please allow up to 24 hours for the changes to propagate
- Enjoy your new `.is-a.dev` domain!
### NS Records
When applying for NS records, please be aware we already support a [wide range of DNS records](https://is-a.dev/docs/faq/#which-records-are-supported), so you may not need them.
In your PR, please provide sufficient reasoning of why you need NS records, to help us mitigate potential abuse. It is helpful to refer to the [FAQ](https://is-a.dev/docs/faq/#who-can-use-ns-records) to see if you will likely be approved for NS records or not. You can see a good example of a request for NS records [here](https://github.com/is-a-dev/register/pull/17592).
***Pull requests adding NS records without sufficient reasoning will be closed.***
> Also see: [Why are you so strict with NS records?](https://is-a.dev/docs/faq/#why-are-you-so-strict-with-ns-records)
> [!NOTE]
> You may bypass these requirements by [donating](https://wdh.gg/pvNCdvs) a small amount of $2 (you can also donate via [GitHub Sponsors](https://wdh.gg/sponsor)). You also get a special role in our [Discord server](https://discord.gg/is-a-dev-830872854677422150)!
>
> If you decide to donate, please email william@is-a.dev (or DM `@williamharrison` on Discord) with your payment receipt and your pull request link.
## Report Abuse
If you find any subdomains being abused, please report them by [creating an issue](https://github.com/is-a-dev/register/issues/new?assignees=&labels=report-abuse&projects=&template=report-abuse.md&title=Report+abuse) with the relevant evidence.
---
We are proud to announce that we are supported by Cloudflare's [Project Alexandria](https://www.cloudflare.com/lp/project-alexandria) sponsorship program. We would not be able to operate without their help! 💖
<a href="https://www.cloudflare.com">
<img alt="Cloudflare Logo" src="https://raw.githubusercontent.com/is-a-dev/register/main/media/cloudflare.png" height="96">
</a>