Turn README into README.md.

1 files changed, 37 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e9fe990
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# ctls
+
+ctls is a Certificate Transparency log server (RFC 6962).
+
+# Compile
+
+    $ erl -make
+
+# Requirements
+
+A running plop application, which in turn requires mnesia to be
+running.
+
+jiffie for JSON encoding and decoding.
+
+# Start
+
+NOTE: Kludge ahead! ctls will turn into a proper OTP application at
+some point in the future.
+
+Make sure mnesia and plop are running and that plop has been
+installed, i.e. has a database. See `plop/README`. You might also want
+to `code:add_pathz("path/to/plop/ebin")`.
+
+    1> inets:start(httpd, [{proplist_file, "httpd_props.conf"}]).
+
+# Logs and traces
+
+As configured in httpd_props.conf, logs can be found in webroot/log/.
+
+To enable a crazy amount of tracing information from inets, do
+
+    1> inets_trace:enable(max, io).
+
+# To do
+
+- Stop using inets httpd mod_esi and make ctls a proper application.