From 2402b6c67668dbd114d0101d3eb55ed58aceb68a Mon Sep 17 00:00:00 2001
From: Tulir Asokan <tulir@maunium.net>
Date: Tue, 8 Sep 2020 15:00:38 +0300
Subject: [PATCH] Add README for ready-to-use packs

---
 packs/README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 packs/README.md

diff --git a/packs/README.md b/packs/README.md
new file mode 100644
index 0000000..d505ee3
--- /dev/null
+++ b/packs/README.md
@@ -0,0 +1,20 @@
+# packs
+
+This directory contains some ready-to-use stickerpack metadata. Currently
+it's just all the packs imported from Scalar (the default integration manager).
+
+To use these, copy the packs you want to `web/packs/`, then edit
+`web/packs/index.json` to include the file names you copied in the `packs`
+array. The index.json file should look something like this:
+
+```json
+{
+  "homeserver_url": "https://example.com",
+  "packs": [
+    "your_telegram_imported_pack.json",
+    "another_telegram_imported_pack.json",
+    "scalar-rabbit.json",
+    "scalar-loading_artist.json"
+  }
+}
+```