From 5b315c4d7119666a207bcf09624be3ea52750a82 Mon Sep 17 00:00:00 2001
From: Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
Date: Tue, 10 Nov 2015 19:31:25 +0900
Subject: Documenting the "zip" type in README

Change-Id: I55e6fd73d39b0cf0e20da27a99ddcced5b5b4063
---
 README | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README b/README
index ad6cb9a..bcb8add 100644
--- a/README
+++ b/README
@@ -202,6 +202,21 @@ NOTE: tarball imports are unlikely to give the same commit SHA1 but the tree
 SHA1 inside (which is what is used for artifact cache IDs) should remain
 stable.
 
+### Zip
+
+Lorry can import a zip file fetched from a URL. The contents will be
+extracted in place and committed directly to master. The new commit will
+be tagged with the basename of the imported zip file (e.g. docbook-xml-4.5.zip
+will be tagged as 'docbook-xml-4.5')
+
+    {
+        "docbook-xml": {
+            "type": "zip",
+            "url": "http://www.docbook.org/xml/4.5/docbook-xml-4.5.zip"
+        }
+    }
+
+
 Tips
 ----
 
-- 
cgit v1.2.1