Add README.

1 files changed, 25 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..b80fa17
--- /dev/null
+++ b/README
@@ -0,0 +1,25 @@
+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.
+
+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. Also, you might
+  want to code:add_pathz("path/to/plop/ebin").
+
+  1> inets:start(), https_server:start().
+
+To do
+
+  Make it a proper application.