From 8a54ce0d064ece8f0c58dd0a5912f6bc0b378d2d Mon Sep 17 00:00:00 2001 From: Akshay Nair Date: Wed, 7 Oct 2020 10:54:12 +0530 Subject: [PATCH] Update API.md --- API.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/API.md b/API.md index cd14511c2..c91be5156 100644 --- a/API.md +++ b/API.md @@ -2,27 +2,28 @@ ## How to register * First you need to create a pull request with your `domains/my-domain.json` file -* This PR will be reviewed, merged -* The changes will take effect in less than a day after the PR gets merged -* `Github pages` users, need to go to their repo settings page and change the domain to `your-domain.is-a.dev` after everything is done +* This PR will be reviewed +* The changes will take effect soon after the PR gets merged * And that's it -Example (for github pages) - +### For github pages users +* A github pages json file (with cname record and https redirection) will look something like this - ```json { "description": "Add some description", - "repo": "https://github.com/user/user.github.io", + "repo": "https://github.com/github-username/github-username.github.io", "owner": { - "username": "your-github-username", + "username": "github-username", "email": "any@email" }, "record": { - "CNAME": "user.github.io" + "CNAME": "github-username.github.io", + "URL": "https://your-domain.is-a.dev" } } ``` +* After the pull request is merged, you will see a 404 error on `your-domain.is-a.dev`. To fix this go to your github page repo's `Settings > Github pages > Custom domain` and add `your-domain.is-a.dev` in the given field -NOTE: For github pages users, to fix the 404 you get after registering the domain, add `your-domain.is-a.dev` to your github pages repo in Settings > Github pages > Custom domain. ## Domains json file