2.0.17

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartacme",
-  "version": "2.0.14",
+  "version": "2.0.17",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartacme",
-  "version": "2.0.14",
+  "version": "2.0.17",
   "private": false,
   "description": "acme implementation in TypeScript",
   "main": "dist/index.js",

ts/smartacme.classes.smartacme.ts

@@ -5,7 +5,7 @@ import * as interfaces from './interfaces';
 import { request } from 'http';
 
 /**
- *
+ * the options for the class @see SmartAcme
  */
 export interface ISmartAcmeOptions {
   accountPrivateKey?: string;
@@ -16,6 +16,16 @@ export interface ISmartAcmeOptions {
   validateRemoteRequest: () => Promise<boolean>;
 }
 
+/**
+ * class SmartAcme
+ * can be used for setting up communication with an ACME authority
+ * 
+ * ```ts
+ * const mySmartAcmeInstance = new SmartAcme({
+ *  // see ISmartAcmeOptions for options
+ * })
+ * ```
+ */
 export class SmartAcme {
   private options: ISmartAcmeOptions;