From 856d3dd13a74aad55e05124ff84c2c01b825c0ae Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Nicolas=20Mass=C3=A9?= <nicolas.masse@itix.fr>
Date: Thu, 26 Mar 2020 10:58:06 +0100
Subject: [PATCH] add doc

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4e82122
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# A docker image for mkcert.dev
+
+mkcert.dev is a tool for developer to generate valid certificates.
+Those certificates can then be used in their dev environment.
+
+This repository provides a dockerfile and a helper script to:
+
+- Create CA certificate
+- Create a server certificate (key + crt)
+- Create a server certificate (p12)
+- Convert the server certificate to JKS format
+- Convert the CA certificate to JKS format
+
+## Usage
+
+```sh
+git clone https://github.com/nmasse-itix/mkcert
+cd mkcert
+docker build . mkcert:dev
+docker run -v /tmp/certs:/certs -e SERVER_HOSTNAMES="localhost.localdomain localhost" -it mkcert:dev
+```