From 27842b2d2499fc406f87ccdcccfbbc1093d55a5b Mon Sep 17 00:00:00 2001
From: Rhea Parekh <rheaparekh12@gmail.com>
Date: Wed, 13 Dec 2017 12:23:04 +0530
Subject: [PATCH] slack importer: Add README.md.

---
 zulip/integrations/slack/README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 zulip/integrations/slack/README.md

diff --git a/zulip/integrations/slack/README.md b/zulip/integrations/slack/README.md
new file mode 100644
index 0000000..f18fc68
--- /dev/null
+++ b/zulip/integrations/slack/README.md
@@ -0,0 +1,13 @@
+# Slack Data Import Tool
+
+The slack import tool has been shifted to the Zulip server repository.
+The data can be converted from slack data format to zulip data format
+using the command `./manage.py convert_slack_data`.
+
+The procedure to use this would be:
+
+1. `./manage.py convert_slack_data <slack_zip_file> <realm_name> --output <output_dir>`.
+2. To import this converted data into a new Zulip instance, use
+    `./manage.py import --destory-rebuild-database <output_dir>`.
+3. To import this converted data into an existing Zulip instance (with multiple realms)
+   use `./manage.py import --import-into-nonempty <output_dir>`.