From 3df59f713d323fa813a99b072282cff5cea6ab10 Mon Sep 17 00:00:00 2001
From: Vadim Shlyakhov <vadp@users.noreply.github.com>
Date: Mon, 20 Feb 2017 12:01:18 +0300
Subject: [PATCH] README: Installation

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 265f3c7..bb1b382 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,11 @@
 This is a nodejs [ZIM](http://www.openzim.org/wiki/OpenZIM) file creator -- mostly a drop-in replacement for [zimwriterfs](https://github.com/wikimedia/openzim/tree/master/zimwriterfs).
 
 A notable exception: it does't support *withFullTextIndex* option.
+
+## Installation
+* Clone *zimmer* from Github or download ZIP
+* Install dependencies: `npm install`
+* Symlink *zimmer* as *zimwriterfs*: `ln -s zimmer.js <some directory in $PATH>/zimwriterfs`
+* Make sure genuine *zimwriterfs* is not in the $PATH
+
+MWoffliner should pick zimmer up instead of zimwriterfs when it creates ZIM file.