Skip to content

Commit

Permalink
remove docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SX-9 authored Nov 9, 2024
1 parent ffe7b83 commit 537cd0d
Showing 1 changed file with 2 additions and 33 deletions.
35 changes: 2 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,40 +3,9 @@
</p>
<h1 align="center">part-of.my.id</h1>

> [!WARNING]
> Project is in ALPHA. Bugs and big changes to registration format are expected.
> [!NOTE]
> Documentation is all on our website [here](https://part-of.my.id/docs#structure).
<a href="https://discord.gg/rFyRF3MMhc"><img alt="Discord Server" src="https://invidget.switchblade.xyz/rFyRF3MMhc"></a>

## registration
1. **Star** and **[Fork](https://github.com/partofmyid/register/fork)** this repository.
2. Add a new file called `your-name.json` in the `/domains` folder to register `your-name.part-of.my.id` subdomain (replace `your-name` with whatever subdomain you want).
3. Edit the file (below is just an **example**, provide a **valid** JSON file with your needs, the format is very strict.)

```json
{
"description": "Project Description (optional)",
"owner": {
"username": "github-username"
},
"record": {
"A": ["1.1.1.1", "1.0.0.1"],
"AAAA": ["::1", "::2"],
"CNAME": "example.com",
"MX": ["mx1.example.com", "mx2.example.com"],
"TXT": ["example_verification=1234567890"],
"SRV": [
{ "priority": 10, "weight": 60, "port": 5060, "target": "sipserver.example.com" },
{ "priority": 20, "weight": 10, "port": 5061, "target": "sipbackup.example.com" }
]
},
"proxied": false
}

```

4. Your pull request will be reviewed and merged. Please don't ignore the pull request checklist. If you ignore the checklist, your pull request will be ignored too. _Make sure to keep an eye on it in case we need you to make any changes!_
5. After the pull request is merged, please allow up to 24 hours for the changes to propagate _(usually, it takes 5..15 minutes)_
6. Enjoy your new domain!

*Domains used for illegal purposes will be removed and permanently banned. Please, provide a clear description of your resource in the pull request.*

0 comments on commit 537cd0d

Please sign in to comment.