From 8aaaeb21ada700648328cf7d7a552881cd5db4c2 Mon Sep 17 00:00:00 2001
From: Daniel M <danielm-github@dnml.de>
Date: Wed, 23 Mar 2022 23:31:46 +0100
Subject: [PATCH] Add README

---
 Cargo.toml |  3 +++
 README.md  | 42 ++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 45 insertions(+)
 create mode 100644 README.md

diff --git a/Cargo.toml b/Cargo.toml
index 774aa33..66efaa0 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -3,6 +3,9 @@ name = "le-easy-certs"
 version = "0.1.0"
 edition = "2021"
 
+[profile.release]
+strip = "debuginfo"
+
 [dependencies]
 acme2 = "0.5"
 env_logger = "0.9"
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..afbbd95
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+# Lé easy certs
+> (Let's Encrypt easy certificates)
+
+## Project state
+This project is in a really early state and is in no way stable or ready for production.
+
+## How to use
+The program reads the configuration file and requests / renews the certificates according to the 
+configuration.
+
+- If specified, the first CLI argument will be used as path for the config file
+- If specified (and no CLI arg), the `LE_CONF` environment variable will be used as path for the 
+  config file
+- If nothing is specified, a config file `./le-conf.toml` will be used
+
+## Example config
+
+```toml
+[http]
+ip = "0.0.0.0"
+port = 80
+
+[certs.example_cert1]
+renew_days = 30
+account_file = "./account.pem"
+fullchain_file = "./example_com_fullchain.pem"
+domains = [
+    "example.com", 
+    "www.example.com", 
+    "sub1.example.com",
+    "sub2.example.com", 
+]
+
+[certs.example_cert2]
+renew_days = 30
+account_file = "./account.pem"
+fullchain_file = "./example2_com_fullchain.pem"
+domains = [
+    "example2.com",
+    "www.example2.com",
+]
+```
\ No newline at end of file