diff --git a/README.md b/README.md index 4a7a21d..7c1bb79 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,8 @@ This section assumes prior knowledge of domain name ownership verification. If n `HTML Meta Tag` is an element that provide metadata about a web page. It is placed in the `head` section of an HTML document and provides information about the page to search engines, web browsers, and other services. This method requires the ability for the users to edit the HTML source code of their site's homepage. - -๐Ÿ’ป Generation +
+๐Ÿ’ป Generation The generator module contains two functions for generating HTML Meta tags to verify ownership of a specific domain name. @@ -77,6 +77,7 @@ if err == nil { // * To stay verified, don't remove the meta tag even after verification succeeds. } ``` +
๐Ÿ”Ž Verification @@ -99,7 +100,8 @@ In the JSON method, you need to create a JSON file that contains a specific str After the JSON file has been uploaded, the ownership verification service can access it and verify its contents to confirm that the user does indeed own the domain. -๐Ÿ’ป Generation +
+๐Ÿ’ป Generation โคต๏ธ `GenerateJsonFromConfig(config *config.JsonGenerator, useInternalCode bool) (*FileInstruction, error)` @@ -151,7 +153,7 @@ if err == nil { // and upload it to the root of your site. } ``` - +
๐Ÿ”Ž Verification Requirements: @@ -182,6 +184,9 @@ fmt.Println("Is ownership verified:", isVerified) This approach is similar to the JSON method. There are two functions you can use to provide verification instructions to users. +
+๐Ÿ’ป Generation + โคต๏ธ `func GenerateXmlFromConfig(config *config.XmlGenerator, useInternalCode bool) (*FileInstruction, error)` ```go @@ -233,6 +238,7 @@ if err == nil { // and upload it to the root of your site. } ``` +
๐Ÿ”Ž Verification @@ -261,7 +267,8 @@ fmt.Println("Is ownership verified:", isVerified) With this method, user needs to add a specific TXT record to the DNS configuration of their domain. The TXT record contains a unique value that proves ownership of the domain. -๐Ÿ’ป Generation +
+๐Ÿ’ป Generation โคต๏ธ `func GenerateTxtRecordFromConfig(config *config.TxtRecordGenerator, useInternalCode bool) (*DnsRecordInstruction, error)` @@ -311,6 +318,7 @@ if err == nil { // Create a TXT record with the name @ and the content yourappname-site-verification=random K-Sortable unique code } ``` +
๐Ÿ”Ž Verification @@ -329,7 +337,8 @@ fmt.Println("Is ownership verified:", isVerified) ### ๐Ÿš€ DNS CNAME record method -๐Ÿ’ป Generation +
+๐Ÿ’ป Generation โคต๏ธ `func GenerateCnameRecordFromConfig(config *config.CnameRecordGenerator) (*DnsRecordInstruction, error)` @@ -356,6 +365,8 @@ if err == nil { > ๐Ÿ’ก Ensure to store the DNS CNAME record information generated, including the Record Name and Record Target. +
+ ๐Ÿ” Verification Requirements: