diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7d9733e --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +node_modules +docs/ +coverage/ \ No newline at end of file diff --git a/README.md b/README.md index 89bfaa9..dde0bbc 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,16 @@ # Cert -Easily setup coreos clusters with encryption for communication between nodes. +Easily obain SSL certificates from LetsEncrypt. Supports DNS-01 challenge. TypeScript ready. + +## Usage + +```typescript +import {Cert} from "cert"; + +myCert = new Cert({ + cfEmail = "some@cloudflare.email", + cfKey = "someCloudflareApiKey", + outputPath = "someOutputPath" // NOTE: if you already have certificates, make sure you put them in here, so cert only requires the missing ones +}); + +myCert.getDomainCert("example.com"); +``` \ No newline at end of file diff --git a/package.json b/package.json index 1e4d882..14d826f 100644 --- a/package.json +++ b/package.json @@ -21,5 +21,8 @@ "bugs": { "url": "https://github.com/pushrocks/cert/issues" }, - "homepage": "https://github.com/pushrocks/cert#readme" + "homepage": "https://github.com/pushrocks/cert#readme", + "dependencies": { + "letsencrypt": "^1.4.4" + } }