From: AsamK <asamk@gmx.de>
Date: Mon, 23 Mar 2020 13:48:52 +0000 (+0100)
Subject: Add documentation for sticker upload
X-Git-Tag: v0.6.6~21
X-Git-Url: https://git.nmode.ca/signal-cli/commitdiff_plain/8a44b3777455a3b123a0f813ebd0df652821b908

Add documentation for sticker upload
---

diff --git a/man/signal-cli.1.adoc b/man/signal-cli.1.adoc
index 4101986f..98a54756 100644
--- a/man/signal-cli.1.adoc
+++ b/man/signal-cli.1.adoc
@@ -287,6 +287,34 @@ sendContacts
 Send a synchronization message with the local contacts list to all linked devices.
 This command should only be used if this is the master device.
 
+uploadStickerPack
+~~~~~~~~~~~~~~~~~
+Upload a new sticker pack, consisting of a manifest file and the stickers in WebP
+format (maximum size for a sticker file is 100KiB).
+The required manifest.json has the following format:
+
+```json
+{
+  "title": "<STICKER_PACK_TITLE>",
+  "author": "<STICKER_PACK_AUTHOR>",
+  "cover": { // Optional cover, by default the first sticker is used as cover
+    "file": "<name of webp file, mandatory>",
+    "emoji": "<optional>"
+  },
+  "stickers": [
+    {
+      "file": "<name of webp file, mandatory>",
+      "emoji": "<optional>"
+    }
+    ...
+  ]
+}
+```
+
+PATH::
+	The path of the manifest.json or a zip file containing the sticker pack you
+	wish to upload.
+
 daemon
 ~~~~~~
 signal-cli can run in daemon mode and provides an experimental dbus interface. For