diff --git a/README.md b/README.md index 95597e1..a595ea5 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,39 @@ -# acme-dns-01-gandi.js +# [acme-dns-01-gandi.js](https://git.rootprojects.org/root/acme-dns-01-gandi.js) | a [Root](https://rootprojects.org/) project -Gandi LiveDNS + Let's Encrypt for Node.js - ACME dns-01 challenges w/ ACME.js and Greenlock.js +###### Gandi LiveDNS + Let's Encrypt for Node.js - ACME dns-01 challenges w/ ACME.js and Greenlock.js +###### This handles ACME dns-01 challenges, compatible with ACME.js and Greenlock.js. Passes acme-dns-01-test. -Features -Compatible - Let’s Encrypt v2.1 / ACME draft 18 (2019) - Gandi.net LiveDNS API - ACME.js, Greenlock.js, and others -Quality - node v6 compatible VanillaJS - < 150 lines of code - Zero Dependencies -Install -npm install --save acme-dns-01-gandi +# Features +* Compatible + * Let’s Encrypt v2.1 / ACME draft 18 (2019) + * Gandi.net LiveDNS API + * ACME.js, Greenlock.js, and others +* Quality + * node v6 compatible VanillaJS + * < 150 lines of code + * Zero Dependencies + +# Install +`npm install --save acme-dns-01-gandi` Generate Gandi LiveDNS API Token: -Login to your account at: -https://account.gandi.net/ +* Login to your account at: https://account.gandi.net/ +* Under the Security section, click the link next to 'Production API key' to generate a token. -Under the Security section, click the link next to 'Production API key' to generate a token. - -Usage +# Usage First you create an instance with your credentials: +``` var dns01 = require('acme-dns-01-gandi').create({ baseUrl: 'https://dns.api.gandi.net/api/v5/', // default token: 'xxxx' }); +``` Then you can use it with any compatible ACME library, such as Greenlock.js or ACME.js. -Greenlock.js +## Greenlock.js +``` var Greenlock = require('greenlock-express'); var greenlock = Greenlock.create({ challenges: { @@ -38,20 +41,23 @@ var greenlock = Greenlock.create({ // ... } }); -See Greenlock Express and/or Greenlock.js documentation for more details. +``` +See [Greenlock Express](https://git.rootprojects.org/root/greenlock-express.js) and/or [Greenlock.js](https://git.rootprojects.org/root/greenlock.js) documentation for more details. -ACME.js -// TODO +## ACME.js +`// TODO` See the ACME.js for more details. -Build your own +## Build your own There are only 5 methods: -init(config) -zones(opts) -set(opts) -get(opts) -remove(opts) +* ```init(config)``` +* ```zones(opts)``` +* ```set(opts)``` +* ```get(opts)``` +* ```remove(opts)``` + +``` dns01 .set({ identifier: { value: 'foo.example.co.uk' }, @@ -66,17 +72,20 @@ dns01 .catch(function() { console.log('Failed to set TXT record'); }); +``` See acme-dns-01-test for more implementation details. -Tests +# Tests +``` # node ./test.js domain-zone api-token node ./test.js example.com xxxxxx -Authors -Jarom Bridges -AJ ONeal +``` +# Authors +* Jarom Bridges +* AJ ONeal See AUTHORS for contact info. -Legal -acme-dns-01-gandi.js | MPL-2.0 | Terms of Use | Privacy Policy +# Legal +[acme-dns-01-gandi.js](https://git.coolaj86.com/coolaj86/acme-dns-01-gandi.js) | MPL-2.0 | [Terms of Use](https://therootcompany.com/legal/#terms) | [Privacy Policy](https://therootcompany.com/legal/#privacy) Copyright 2019 The Root Group LLC \ No newline at end of file