From b2290599531d9b0b7e82351f3ad2e9c6bb67bf36 Mon Sep 17 00:00:00 2001
From: Bart van Strien <bart.bes@gmail.com>
Date: Fri, 5 Jun 2015 22:07:27 +0200
Subject: [PATCH] Add https module documentation

---
 doc/https.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 doc/https.md

diff --git a/doc/https.md b/doc/https.md
new file mode 100644
index 0000000..8632ee0
--- /dev/null
+++ b/doc/https.md
@@ -0,0 +1,14 @@
+Functions
+---------
+
+### https.request ###
+
+    res, code, headers, status = https.request(url, [body])
+
+See the luasocket documentation for `http.request`. In the url table, apart
+from the usual luasocket flags, luasec flags can be specified. Note that
+`proxy` and `redirect` are not supported.
+
+**WARNING**: Peer verification is off by default. It is highly recommended to
+specify either a `capath` or a `cafile` in the flags, and turn peer
+verification on.