From 0d7913ab615ace643e2970f2adf2f73c961136f4 Mon Sep 17 00:00:00 2001
From: Lukas Schauer <lukas@schauer.so>
Date: Mon, 7 Dec 2015 14:56:04 +0100
Subject: [PATCH] renamed import scripts, updated readme

---
 README.md                           | 49 +++++++++++++++++++++++++++++
 json_to_pem.pl => import-account.pl |  0
 import.sh => import-certs.sh        |  0
 3 files changed, 49 insertions(+)
 rename json_to_pem.pl => import-account.pl (100%)
 rename import.sh => import-certs.sh (100%)

diff --git a/README.md b/README.md
index 89d7e8a..7a33086 100644
--- a/README.md
+++ b/README.md
@@ -15,3 +15,52 @@ Current features:
 
 Please keep in mind that this software and even the acme-protocol are relatively young and may still have some unresolved issues.
 Feel free to report any issues you find with this script or contribute by submitting a pullrequest.
+
+## Usage:
+
+Add domains to domains.txt like in this example:
+
+```
+example.com www.example.com
+example.net www.example.net wiki.example.net
+```
+
+This states that there should be two certificates `example.com` and `example.net`,
+with the other domains in the corresponding line being their alternative names.
+
+You'll also need to set up a webserver to serve the challenge-response directory as configured with `$WELLKNOWN`,
+or you can use the hook in the script if you want to deploy it some other way (e.g. copy it to a server via scp).
+
+After doing those two things you can just `./letsencrypt.sh`, and it should generate certificates.
+
+It can be used inside a cronjob as it automatically detects if a certificate is about to expire.
+
+### nginx
+
+If you want to use nginx you can set up a location block to serve your challenge responses:
+
+```
+location /.well-known/acme-challenge {
+  root /var/www/letsencrypt;
+}
+```
+
+## Import
+
+### import-account.pl
+
+This perl-script can be used to import the account key from the original letsencrypt client.
+
+You should copy `private_key.json` to the same directory as the script.
+The json-file can be found in a subdirectory of `/etc/letsencrypt/accounts/acme-v01.api.letsencrypt.org/directory`.
+
+Usage: `perl import-account.pl`
+
+### import-certs.sh
+
+This script can be used to import private keys and certificates created by the original letsencrypt client.
+
+By default it expects the certificates to be found under `/etc/letsencrypt`, which is the default output directory of the original client.
+You can change the path by setting LETSENCRYPT in your config file: ```LETSENCRYPT="/etc/letsencrypt"```.
+
+Usage: `./import-certs.sh`
diff --git a/json_to_pem.pl b/import-account.pl
similarity index 100%
rename from json_to_pem.pl
rename to import-account.pl
diff --git a/import.sh b/import-certs.sh
similarity index 100%
rename from import.sh
rename to import-certs.sh