From 56e741239e34340bf6e3a7b77cba1a637746d5f1 Mon Sep 17 00:00:00 2001 From: feliximafidon <36160264+feliximafidon@users.noreply.github.com> Date: Wed, 23 Mar 2022 21:48:35 +0100 Subject: [PATCH] Update README.md Updated documentation for call to Client function to not include the protocol in the domain name, as this throws the error "getaddrinfo ENOTFOUND" --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f66553a..e8802e3 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,10 @@ var Postal = require('@atech/postal'); // Create a new Postal client using a server key generated using your // installation's web interface -var client = new Postal.Client('https://postal.yourdomain.com', 'your-api-key'); +// Note: It is important that you don't specify the protocol "https://", +// as doing that on some systems throws the error "getaddrinfo ENOTFOUND" +// Internally, Client uses the https library to connect to the domain +var client = new Postal.Client('postal.yourdomain.com', 'your-api-key'); // Create a new message var message = new Postal.SendMessage(client);