root
/
acme-dns-01-dnsimple.js
mirror of https://git.coolaj86.com/coolaj86/acme-dns-01-dnsimple.js.git
2
0
Fork 0
Code Issues Releases Wiki Activity

doc updates

This commit is contained in:
AJ ONeal 2019-07-30 20:27:15 -06:00
parent 138e2ecfae
commit 8a75e5ee1c
2 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -8,7 +8,7 @@ Handles ACME dns-01 challenges. Compatible with ACME.js and Greenlock.js. Passes
- Compatible - Compatible
- Let’s Encrypt v2.1 / ACME draft 18 (2019) - Let’s Encrypt v2.1 / ACME draft 18 (2019)
- DNSimple API - DNSimple v2 API
- ACME.js, Greenlock.js, and others - ACME.js, Greenlock.js, and others
- Quality - Quality
- node v6 compatible VanillaJS - node v6 compatible VanillaJS
@ -32,7 +32,8 @@ First you create an instance with your credentials:
```js ```js
var dns01 = require('acme-dns-01-dnsimple').create({ var dns01 = require('acme-dns-01-dnsimple').create({
baseUrl: '{{ api url }}', // default baseUrl: 'https://api.dnsimple.com/v2/', // default
account: 'johndoe',
token: 'xxxx' token: 'xxxx'
}); });
``` ```
@ -93,7 +94,7 @@ See acme-dns-01-test for more implementation details.
# Tests # Tests
```bash ```bash
# node ./test.js domain-zone username password # node ./test.js domain-zone account token
node ./test.js example.com johndoe xxxxxx node ./test.js example.com johndoe xxxxxx
``` ```

4
example.env
View File

@ -1,3 +1,3 @@
ZONE=example.co.uk ZONE=example.co.uk
USERNAME=johndoe ACCOUNT=johndoe
PASSWORD=xxxxxxxx TOKEN=xxxxxxxx