summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-05-01 16:03:27 +0200
committerLoïc Hoguin <[email protected]>2013-05-01 16:39:35 +0200
commit117cb7171106aba8fe7028fbf9ed07a037778bcd (patch)
tree36840b3c95921198672b16c9d32d416829ca26a0 /README.md
downloadct_helper-117cb7171106aba8fe7028fbf9ed07a037778bcd.tar.gz
ct_helper-117cb7171106aba8fe7028fbf9ed07a037778bcd.tar.bz2
ct_helper-117cb7171106aba8fe7028fbf9ed07a037778bcd.zip
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c67e570
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+ct_helper
+=========
+
+Helper modules for common_test suites.
+
+Generating SSL certificates
+---------------------------
+
+This library includes a function that allows you to generate SSL
+certificates for testing purposes. The following snippet can be
+used to generate certificates and a private key.
+
+``` erlang
+{CaCert, Cert, Key} = ct_helper:make_certs().
+```
+
+The resulting `CaCert`, `Cert` and `Key` can be used directly with
+Erlang functions like `ssl:connect/3`.
+
+``` erlang
+ssl:connect("example.com", 443, [binary, {cert, Cert}, {key, Key}]).
+```
+
+Support
+-------
+
+ * Official IRC Channel: #ninenines on irc.freenode.net
+ * [Mailing Lists](http://lists.ninenines.eu)