From 8b69fd1d72c477e616972dfafbabd132c666db2d Mon Sep 17 00:00:00 2001 From: Joab <89288499+Joabutt@users.noreply.github.com> Date: Tue, 26 Dec 2023 11:06:37 +0800 Subject: [PATCH] Update JSON_TEMPLATE.md added new type support --- JSON_TEMPLATE.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/JSON_TEMPLATE.md b/JSON_TEMPLATE.md index 5328e65..26ded37 100644 --- a/JSON_TEMPLATE.md +++ b/JSON_TEMPLATE.md @@ -2,13 +2,24 @@ Please follow the template given here or your pull request will not be accepted or merged. -### IMPORTANT: Please name your JSON file the subdomain you wish to have. If your subdomain in the JSON file does not match the file name, your PR will NOT be merged. Also please do **NOT** have a comma after your email, as it will cause internal server errors. Please do not add any line breaks in your json. +### IMPORTANT: Please name your JSON file the subdomain you wish to have. If your subdomain in the JSON file does not match the file name, your PR will NOT be merged. Also please do **NOT** have a comma after your email, as it will cause internal server errors. Please do not add any line breaks in your json. + +## To add define which record you want to add, add the type field to the json. Currently supported records: CNAME, A, TXT, MX ## Template: ``` { "subdomain": "YOUR_SUBDOMAIN_HERE", "url": "YOUR_SITE_URL_HERE", - "email": "YOUR_EMAIL_HERE" + "email": "YOUR_EMAIL_HERE", + "type": "YOUR_TYPE_HERE" } ``` + +## Example: +{ + "subdomain": "joabutt", + "url": "joabutt.dev", + "email": "me@joabutt.dev", + "type": "CNAME" +}