chore: update readme

Author: adamlacombe

README.md

@@ -1 +1,40 @@
-# it-acme-client
+# acme-client
+Simple scalable automatic solution for obtaining SSL certificates.
+
+## Example
+```typescript
+import * as https from 'https';
+import {AcmeClient} from '@interactivetraining/acme-client';
+
+new AcmeClient({
+  domain: 'my-domain.com',
+  email: '[email protected]',
+  googleCloud: {
+    projectId: process.env.GOOGLE_CLOUD_PROJECT_ID,
+    bucketName: process.env.GOOGLE_CLOUD_SSL_BUCKET_NAME,
+    credentials: {
+      email: process.env.GOOGLE_CLOUD_CLIENT_EMAIL,
+      privateKey: process.env.GOOGLE_CLOUD_CLIENT_PRIVATE_KEY
+    }
+  },
+  cloudflare: {
+    email: process.env.CLOUDFLARE_EMAIL,
+    apiKey: process.env.CLOUDFLARE_API_KEY
+  },
+  fileNames: {
+    cert: 'my-domain-prod-cert.pem',
+    caCert: 'my-domain-prod-caCert.pem',
+    privateKey: 'my-domain-prod-private-key.pem',
+    accountKey: 'my-domain-prod-account-key.pem'
+  },
+  acmeServer: 'prod',
+  agreeTerms: true
+}).getCert().then((res) => {
+  https.createServer({
+    cert: res.cert,
+    key: res.key
+  }, () => {
+    
+  });
+});
+```

package.json

@@ -1,22 +1,41 @@
 {
-  "name": "it-acme-client",
+  "name": "@interactivetraining/acme-client",
   "version": "0.0.1",
-  "description": "",
+  "description": "Simple scalable automatic solution for obtaining SSL certificates.",
+  "keywords": [
+    "acme client",
+    "lets encrypt",
+    "ssl",
+    "cloud",
+    "typescript"
+  ],
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc"
   },
-  "author": "Interactive Training",
+  "author": "Interactive Training (http://interactive.training)",
   "license": "MIT",
   "devDependencies": {
+    "@types/node": "^11.13.5",
     "typescript": "^3.4.3"
   },
   "dependencies": {
     "@google-cloud/storage": "^2.5.0",
-    "@types/node": "^11.13.4",
     "cloudflare": "^2.4.1",
     "letiny": "^0.2.1-1",
     "reflect-metadata": "^0.1.13",
     "typedi": "^0.8.0"
+  },
+  "homepage": "https://github.com/InteractiveTraining/acme-client#acme-client",
+  "maintainers": [
+    "Adam LaCombe (https://github.com/adamlacombe)"
+  ],
+  "bugs": {
+    "url": "https://github.com/InteractiveTraining/acme-client/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/InteractiveTraining/acme-client.git"
   }
 }

src/index.ts

@@ -6,7 +6,7 @@ import {GCloudStorageService} from './services/gCloudStorageService';
 import {ConfigService} from './services/configService';
 import {CloudflareService} from './services/cloudflareService';
 
-export class itAcmeClient {
+export class AcmeClient {
   config: ConfigService;
   gCloudStorage: GCloudStorageService;
   cloudflareService: CloudflareService;