From 1435c5089da00fcb6aae5af991882db2247a4015 Mon Sep 17 00:00:00 2001
From: Michael Hansen <mike@rhasspy.org>
Date: Mon, 11 Apr 2022 15:30:03 -0400
Subject: [PATCH] Add Docker and Debian package instructions

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

diff --git a/README.md b/README.md
index a16589d..90595e1 100644
--- a/README.md
+++ b/README.md
@@ -55,6 +55,64 @@ mycroft-config set tts.module mimic3_tts_plug
 See the [plugin's documentation](https://github.com/MycroftAI/plugin-tts-mimic3) for more options.
 
 
+### Docker image
+
+A pre-built Docker image is available for the following platforms:
+
+* `linux/amd64`
+    * For desktops and laptops (`x86_64` CPUs)
+* `linux/arm64`
+    * For Raspberry 3/4 and Zero 2 with [64-bit Pi OS](https://www.raspberrypi.com/news/raspberry-pi-os-64-bit/)
+* `linux/arm/v7`
+    * For Raspberry Pi 1/2/3/4 and Zero 2 with 32-bit Pi OS
+    
+Install/update with:
+
+``` sh
+docker pull mycroftai/mimic3
+```
+
+Once installed, check out the following scripts for running:
+
+    * [`mimic3`](docker/mimic3)
+    * [`mimic3-server`](docker/mimic3-server)
+    * [`mimic3-download`](docker/mimic3-download)
+    
+Or you can manually run the web server with:
+
+``` sh
+docker run \
+       -it \
+       -p 59125:59125 \
+       -v "${HOME}/.local/share/mimic3:/home/mimic3/.local/share/mimic3" \
+       'mycroftai/mimic3'
+```
+
+
+### Debian Package
+
+Grab the Debian package from the [latest release](https://github.com/mycroftAI/mimic3/releases) for your platform:
+
+* `mimic3-tts_<version>_amd64.deb`
+    * For desktops and laptops (`x86_64` CPUs)
+* `mimic3-tts_<version>_arm64.deb`
+    * For Raspberry 3/4 and Zero 2 with [64-bit Pi OS](https://www.raspberrypi.com/news/raspberry-pi-os-64-bit/)
+* `mimic3-tts_<version>_armhf.deb`
+    * For Raspberry Pi 1/2/3/4 and Zero 2 with 32-bit Pi OS
+    
+Once downloaded, install the package with:
+
+``` sh
+sudo apt install ./mimic3-tts_<version>_<platform>.deb
+```
+
+Once installed, the following commands will be available:
+
+    * `mimic3`
+    * `mimic3-server`
+    * `mimic3-download`
+
+
 ### Using pip
 
 Install the command-line tool: