diff --git a/README.md b/README.md index b179898..afd7a49 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,36 @@ -le-store-certbot -================ +# Deprecated + +`le-store-certbot` has been replaced with [`le-store-fs`](https://git.coolaj86.com/coolaj86/le-store-fs.js). + +The new storage strategy **keeps file system compatibility**, but **drops support** for Python config files. + +Unless you're running `certbot` and Greenlock side-by-side, or interchangeably, you switch to `le-store-fs`. + +## Migrating to `le-store-fs` + +It's **painless** and all of your existing certificates will be **preserved** +(assuming you use the same `configDir` as before). + +```js +Greenlock.create({ + + // Leave configDir as it, if you've been setting it yourself. + // Otherwise you should explicitly set it to the previous default: + configDir: '~/letsencrypt/etc' + + // le-store-fs takes the same options as le-store-certbot, + // but ignores some of the ones that aren't important. +, store: require('le-store-fs').create({}) + + ... +}) +``` + +## Alternatives + + * Search npm for ["le-store-"](https://www.npmjs.com/search?q=le-store-) to find many alternatives. + +# le-store-certbot The "certbot" storage strategy for [Greenlock.js](https://git.coolaj86.com/coolaj86/le-store-certbot.js). diff --git a/package.json b/package.json index 76cbf80..be52b89 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "le-store-certbot", - "version": "2.2.1", + "version": "2.2.2", "description": "The \"certbot\" storage strategy for Greenlock.js", "main": "index.js", "scripts": {