From e9dafc86d63babc5c157c4fe2f84b05d02732dfb Mon Sep 17 00:00:00 2001 From: infinityofspace <30715462+infinityofspace@users.noreply.github.com> Date: Thu, 1 Apr 2021 13:31:48 +0200 Subject: [PATCH] fixed typos in Readme; added note for the DNS records import and export feature --- Readme.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/Readme.md b/Readme.md index 3d52aad..c0058df 100644 --- a/Readme.md +++ b/Readme.md @@ -51,11 +51,11 @@ pip install . ### Usage -Each request must be made with the API Key and Secret. You can easily create them at Porkbun. Just follow +Each request must be made with the API key and secret. You can easily create them at Porkbun. Just follow the [official instructions](https://porkbun.com/api/json/v3/documentation#Authentication). Make sure that you explicitly activate the API usage for your domain at the end. -After installation *pkb_client* is available under the command *pkb-client*. +After installation *pkb_client* is available under the command `pkb-client`. You have to specify your API key and secret each time as follows: @@ -85,11 +85,11 @@ Create a new TXT record for the subdomain `test` of the domain `example.com` wit of `500`: ```commandline -pkb-client -k -s dns-create example.com TXT "porkbun is cool" --name test --ttl 500 +pkb-client -k -s dns-create example.com TXT "porkbun is cool" --name test --ttl 500 ``` The call returns the DNS record id. The record DNS ids are used to distinguish the DNS records and can be used for -editing or deleting records. +editing or deleting records. The ID is only a Porkbun internal identifier and is not publicly available. Delete the DNS record with the ID `12345` of the domain `example.com`: @@ -121,6 +121,8 @@ Remove all existing DNS records of the domain `example.com` and restore the DNS pkb-client -k -s dns-import example.com dns_recods.json clear ``` +*Note:* The import function uses the record ID to distinguish DNS records. + ### Third party notices All modules used by this project are listed below: