updated readme

[andy/dehydrated.git] / README.md

diff --git a/README.md b/README.md
index 0e00322a114e2f3e3523e6429437dcba91f05775..af523f1a9cbed903b21a68d3764eceb094b67b3c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,17 @@
 # letsencrypt.sh
 
-letsencrypt client implemented as a shell-script
+This is a client for signing certificates with an ACME-server (currently only provided by letsencrypt) implemented as a relatively simple shell-script.
+
+It uses the `openssl` utility for everything related to actually handling keys and certificates, so you need to have that installed.
+
+Other dependencies are (for now): curl, sed
+
+Perl no longer is a dependency.
+The only remaining perl code in this repository is the script you can use to convert your existing keyfile into something openssl (and this script) can read.
+
+Current features:
+- Signing of a list of domains
+- Renewal if a certificate is about to expire
+
+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.