diff --git a/README.md b/README.md index b6b65d7..a1b3bc2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Go library for updating DS records with DK Hostmasters proprietary DS Update protocol +# Go library for updating DS records with Punktum.dk's proprietary DS Update protocol [![Codecov](https://codecov.io/gh/arnested/dsupdate/branch/main/graph/badge.svg)](https://codecov.io/gh/arnested/dsupdate) [![CLA assistant](https://cla-assistant.io/readme/badge/arnested/dsupdate)](https://cla-assistant.io/arnested/dsupdate) @@ -8,15 +8,15 @@ import "arnested.dk/go/dsupdate" ``` -Package dsupdate is a library for updating DS records with DK -Hostmasters proprietary DS Update protocol. +Package dsupdate is a library for updating DS records with +Punktum.dk's (DK Hostmasters) proprietary DS Update protocol. DS Update is a proprietary protocol and service developed and offered -by DK Hostmaster as an interface for updating DNSSEC related DS -records associated with a .dk domain name. +by Punktum as an interface for updating DNSSEC related DS records +associated with a .dk domain name. The service and protocol is documented at -. +. This package has functionality to update or delete DS records using the DS Update protocol. diff --git a/README.md.template b/README.md.template index 56d7d13..aa140a9 100644 --- a/README.md.template +++ b/README.md.template @@ -1,4 +1,4 @@ -# Go library for updating DS records with DK Hostmasters proprietary DS Update protocol +# Go library for updating DS records with Punktum.dk's proprietary DS Update protocol [![Codecov](https://codecov.io/gh/arnested/dsupdate/branch/main/graph/badge.svg)](https://codecov.io/gh/arnested/dsupdate) [![CLA assistant](https://cla-assistant.io/readme/badge/arnested/dsupdate)](https://cla-assistant.io/arnested/dsupdate) diff --git a/doc.go b/doc.go index 4aafdf6..1fcc802 100644 --- a/doc.go +++ b/doc.go @@ -1,13 +1,13 @@ /* -Package dsupdate is a library for updating DS records with DK -Hostmasters proprietary DS Update protocol. +Package dsupdate is a library for updating DS records with +Punktum.dk's (DK Hostmasters) proprietary DS Update protocol. DS Update is a proprietary protocol and service developed and offered -by DK Hostmaster as an interface for updating DNSSEC related DS -records associated with a .dk domain name. +by Punktum as an interface for updating DNSSEC related DS records +associated with a .dk domain name. The service and protocol is documented at -. +. This package has functionality to update or delete DS records using the DS Update protocol. diff --git a/dsupdate.go b/dsupdate.go index 0951978..19382fa 100644 --- a/dsupdate.go +++ b/dsupdate.go @@ -7,11 +7,11 @@ import ( // BaseURL is the endpoint of the DS Update service. type BaseURL string -// DK Hostmasters environments are predefined as constants. +// Punktum.dk's environments are predefined as constants. const ( - // Production environment of DK Hostmasters DSU service. + // Production environment of Punktum.dk's DSU service. Production BaseURL = "https://dsu.dk-hostmaster.dk/1.0" - // Sandbox environment of DK Hostmasters DSU service. + // Sandbox environment of Punktum.dk's DSU service. Sandbox BaseURL = "https://dsu-sandbox.dk-hostmaster.dk/1.0" ) @@ -38,8 +38,8 @@ type DsRecord struct { //nolint:lll type Client struct { Domain string // .dk domain name, i.e eksempel.dk - UserID string // DK Hostmaster user ID, i.e. ABCD1234-DK - Password string // DK Hostmater password + UserID string // Punktum.dk user ID, i.e. ABCD1234-DK + Password string // Punktum.dk password BaseURL BaseURL // DS Update service base URL. You can use constants dsupdate.Production (default) or dsupdate.Sandbox HTTPClient *http.Client } diff --git a/example_test.go b/example_test.go index 1a613ea..dada6f7 100644 --- a/example_test.go +++ b/example_test.go @@ -19,8 +19,8 @@ func Example_update() { // Create a client with some fake credentials. client := dsupdate.Client{ Domain: "eksempel.dk", // .dk domain name - UserID: "ABCD1234-DK", // DK Hostmaster user ID - Password: "abba4evah", // DK Hostmaster password + UserID: "ABCD1234-DK", // Punktum.dk user ID + Password: "abba4evah", // Punktum.dk password BaseURL: dsupdate.Sandbox, // If left out defaults to dsupdate.Production HTTPClient: &http.Client{ Timeout: 5 * time.Second, @@ -39,7 +39,7 @@ func Example_update() { ctx := context.Background() - // Post the new DS record(s) to DK Hostmaster. + // Post the new DS record(s) to Punktum.dk. resp, err := client.Update(ctx, records) // If the update failed and a substatus was returned in the @@ -62,7 +62,7 @@ func Example_update() { // If there was no error returned the update succeeded. `resp` // will be the body of whatever was returned from the DS // Update service ("Request sent to DSU::Version_1_0 okay"). - fmt.Printf("Succeeded. DK Hostmaster responded with the message in the body: %s", resp) + fmt.Printf("Succeeded. Punktum.dk responded with the message in the body: %s", resp) } // This example deletes existing DS records of the eksempel.dk @@ -74,8 +74,8 @@ func Example_delete() { // Create a client with some fake credentials. client := dsupdate.Client{ Domain: "eksempel.dk", // .dk domain name - UserID: "ABCD1234-DK", // DK Hostmaster user ID - Password: "abba4evah", // DK Hostmaster password + UserID: "ABCD1234-DK", // Punktum.dk user ID + Password: "abba4evah", // Punktum.dk password BaseURL: dsupdate.Sandbox, // If left out defaults to dsupdate.Production HTTPClient: &http.Client{}, // If left out defaults to http.DefaultClient } @@ -85,7 +85,7 @@ func Example_delete() { ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) defer cancel() - // Delete the DS record(s) to DK Hostmaster. + // Delete the DS record(s) to Punktum.dk. resp, err := client.Delete(ctx) // If the update failed and a substatus was returned in the @@ -108,5 +108,5 @@ func Example_delete() { // If there was no error returned the delete succeeded. `resp` // will be the body of whatever was returned from the DS // Update service. - fmt.Printf("Succeeded. DK Hostmaster responded with the message in the body: %s", resp) + fmt.Printf("Succeeded. Punktum.dk responded with the message in the body: %s", resp) }