diff --git a/API.md b/API.md
index 43bc51d64..a69ee4984 100644
--- a/API.md
+++ b/API.md
@@ -1,13 +1,29 @@
-# Documentation
-
-## How to register
+# How to register
* First you need to create a pull request with your `domains/my-domain.json` file
* This PR will be reviewed
* The changes will take effect soon after the PR gets merged
* And that's it
+### Simple cname record
+* A github pages json file will look something like this -
+```json
+{
+ "description": "Add some description",
+ "repo": "https://github.com/github-username",
+ "owner": {
+ "username": "github-username",
+ "email": "any@email"
+ },
+ "record": {
+ "CNAME": "the-domain-you-own.com"
+ }
+}
+```
+* After the pull request is merged, configure your server (apache, nginx, whatever) to work with `subdomain.is-a.dev`
+
+
### For github pages users
-* A github pages json file (with cname record and https redirection) will look something like this -
+* A github pages json file will look something like this -
```json
{
"description": "Add some description",
@@ -26,12 +42,13 @@
-## Domains json file
+# Domains json file
The way you register your own domain name is through a pull request.
To register `my-domain.is-a.dev`, you need to create a `domains/my-domain.json` file
+### Filename
The file name must pass the following criteria -
-* Must be alpha numeric with dashes as seperators
+* Must be alpha-numeric in lowercase with dashes as seperators
* Must be more than 2 characters long
@@ -51,6 +68,18 @@ In the owner object, the fields `username` and `email` are required. You can how
}
```
+If you don't wish to share your email address here, please share your twitter or any other social media account.
+```json
+{
+ "owner": {
+ "username": "github-username",
+ "email": "",
+ "twitter": "twitter-handle"
+ },
+}
+```
+
+
### description
Describe your domain name and your usage. This is purely for documentation purpose and is optional.
@@ -67,6 +96,7 @@ Currently, only `CNAME`, `A`, `URL` record types are supported.
Here's a few different use cases for the given record types -
* **CNAME**
+CNAME must be a host name (Eg - `something.tld`)
```json
{
"record": {
@@ -76,6 +106,7 @@ Here's a few different use cases for the given record types -
```
* **A record**
+A record must be a list of ips
```json
{
"record": {
diff --git a/README.md b/README.md
index fce687fbe..c07fc8320 100644
--- a/README.md
+++ b/README.md
@@ -19,19 +19,14 @@ Note: This service is currently in **beta** so expect some delays in PR merge an
## Donations
-This project is a free service for developers and will stay that way.
+This project is a free and open source service for developers and will stay that way.
-Donations will be greatly appreciated!
+Please consider donating to help me keep this running forever!
-## Report abuse
-If you think someone is abusing a domain you can report it by creating an issue with the label `report-abuse`.
-
-
-
## License
This project is under the [GPL-3.0](./LICENSE) license.
diff --git a/domains/r2d2.json b/domains/r2d2.json
new file mode 100644
index 000000000..e7dd00801
--- /dev/null
+++ b/domains/r2d2.json
@@ -0,0 +1,12 @@
+{
+ "description": "R2D2 website",
+ "owner": {
+ "username": "r2d2",
+ "email": "aereg@ya.ru"
+ },
+ "record": {
+ "A": [
+ "46.32.81.244"
+ ]
+ }
+}
\ No newline at end of file
diff --git a/domains/rohith.json b/domains/rohith.json
new file mode 100644
index 000000000..df63c3506
--- /dev/null
+++ b/domains/rohith.json
@@ -0,0 +1,12 @@
+
+{
+ "description": "Rohith's personal website",
+ "repo": "https://github.com/rohithp7777",
+ "owner": {
+ "username": "rohithp7777",
+ "email": "rohithp8899@gmail.com"
+ },
+ "record": {
+ "CNAME": "rohith-1c974.web.app"
+ }
+}
diff --git a/domains/vikyaiyer.json b/domains/vikyaiyer.json
new file mode 100644
index 000000000..1c8b3a1d1
--- /dev/null
+++ b/domains/vikyaiyer.json
@@ -0,0 +1,13 @@
+{
+ "description": "Vignesh Aiyer is a Developer!",
+ "repo": "https://github.com/vikyaiyer/jekyll-theme-minimal-resume",
+ "owner": {
+ "username": "vikyaiyer",
+ "email": "vikyaiyer1997@gmail.com"
+ },
+ "record": {
+ "CNAME": "vikyaiyer.github.io",
+ "URL": "https://vikyaiyer.is-a.dev"
+ }
+ }
+