From 91a8c8b237e7a4eb9e045017258e2ab1c115f182 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Tue, 23 Jul 2019 02:24:03 -0600 Subject: [PATCH] doc and cleanup --- README.md | 8 ++++---- example.env | 2 +- package-lock.json | 6 ++++++ package.json | 3 ++- 4 files changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2c30085..9c2ec7c 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,10 @@ First you create an instance with your credentials: ```js var dns01 = require('acme-dns-01-namecheap').create({ - apiUser: 'username', - apiKey: 'xxxx', - clientIp: 'public ip', - username: 'username', + apiUser: 'jdoe', + apiKey: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', + clientIp: '121.22.123.22', + username: 'jdoe', baseUrl: 'https://api.namecheap.com/xml.response' // default }); ``` diff --git a/example.env b/example.env index 2ae855f..7fc79e6 100644 --- a/example.env +++ b/example.env @@ -1,6 +1,6 @@ ZONE=example.co.uk API_USER=exampleuser -API_KEY=xxxxxxxxxxxxxxx +API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx USERNAME=exampleuser CLIENT_IP=121.22.123.22 diff --git a/package-lock.json b/package-lock.json index 905ac0b..6e7c446 100644 --- a/package-lock.json +++ b/package-lock.json @@ -35,6 +35,12 @@ "acme-challenge-test": "^3.3.1" } }, + "dotenv": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-8.0.0.tgz", + "integrity": "sha512-30xVGqjLjiUOArT4+M5q9sYdvuR4riM6yK9wMcas9Vbp6zZa+ocC9dp6QoftuhTPhFAiLK/0C5Ni2nou/Bk8lg==", + "dev": true + }, "sax": { "version": "1.2.4", "resolved": "https://registry.npmjs.org/sax/-/sax-1.2.4.tgz", diff --git a/package.json b/package.json index a586c77..a571807 100644 --- a/package.json +++ b/package.json @@ -31,6 +31,7 @@ }, "devDependencies": { "acme-challenge-test": "^3.3.2", - "acme-dns-01-test": "^3.2.1" + "acme-dns-01-test": "^3.2.1", + "dotenv": "^8.0.0" } }