From d2ca6038dc94dbc06ddb0f3e9709c65a53214196 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Mon, 4 Nov 2019 21:40:28 -0700 Subject: [PATCH] update docs --- README.md | 30 ++++++++++++++++++++++++++++-- package.json | 2 +- 2 files changed, 29 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 59183f9..115a3e5 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,38 @@ Manages SSL Certificate issue and renewal for [Greenlock](https://git.rootprojec Saves global and per-site config to a local File Sytem (current), with optional encrypted Cloud backup (coming soon). +## Install + ```bash npm install --save greenlock@3 npm install --save greenlock-manager@3 ``` +## Usage + +To enable encrypted cloud backup, when it becomes available: + +```js +npx greenlock init --manager cloud --manager-config-file './greenlock.json' +``` + +For local file system only: + +```js +npx greenlock init --manager fs --manager-config-file './greenlock.json' +``` + +Or, place this file in the root of your project: + +`.greenlockrc`: + +```json +{ + "manager": "@greenlock/manager", + "configFile": "./greenlock.json" +} +``` + # Greenlock Manager CLI & API All manager plugins have the **same API**. @@ -22,7 +49,7 @@ Instead, use the CLI (current) or Web API (coming soon). ## Initialize the Manager ```bash -npx greenlock init --manager cloud --manager-token 'xxxx' --manager-config-file './greenlock.json' +npx greenlock init --manager cloud --manager-config-file './greenlock.json' ``` Note: You **should not** initialize greenlock directly as @@ -34,7 +61,6 @@ Instead use the file generated by the CLI `init` (shown above). Greenlock.create({ manager: "@greenlock/manager", cloud: true, - token: "xxxx", configFile: "./greenlock.json", packageRoot: __dirname }); diff --git a/package.json b/package.json index 7082002..22973d4 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@greenlock/manager", - "version": "3.0.0", + "version": "3.0.1", "description": "FileSytem-based Manager with optional encrypted Cloud backup for Greenlock SSL", "main": "manager.js", "files": [