From 6ea55bef93f8aea700475031e8bb1c3f9f678add Mon Sep 17 00:00:00 2001
From: Rodrigo Belem <rodrigo@jozian.com>
Date: Thu, 2 Apr 2020 16:26:55 -0400
Subject: [PATCH] Add initial README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..25f58d2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+[![Support room on Matrix](https://img.shields.io/matrix/mx-puppet-bridge:sorunome.de.svg?label=%23mx-puppet-bridge%3Asorunome.de&logo=matrix&server_fqdn=sorunome.de)](https://matrix.to/#/#mx-puppet-bridge:sorunome.de)[![donate](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/Sorunome/donate)
+
+# mx-puppet-skype
+This is a skype puppeting bridge for matrix. It is based on [mx-puppet-bridge](https://github.com/Sorunome/mx-puppet-bridge) and provide multi-user instances.
+
+## Quick start using Docker
+
+Docker image can be found at https://hub.docker.com/r/sorunome/mx-puppet-skype
+
+For docker you probably want the following changes in `config.yaml`:
+
+```yaml
+bindAddress: '0.0.0.0'
+filename: '/data/database.db'
+file: '/data/bridge.log'
+```
+
+Also check the config for other values, like your homeserver domain.
+
+## Install Instructions (from Source)
+
+*   Clone and install:
+    ```
+    git clone https://github.com/Sorunome/mx-puppet-skype.git
+    cd mx-puppet-skype
+    npm install
+*   Edit the configuration file and generate the registration file:
+    ```
+    cp sample.config.yaml config.yaml
+    # fill info about your homeserver and skype app credentials to config.yaml manually
+    npm run start -- -r # generate registration file
+    or
+    docker run -v </path/to/host>/data:/data -it sorunome/mx-puppet-skype -r
+    ```
+*   Copy the registration file to your synapse config directory.
+*   Add the registration file to the list under `app_service_config_files:` in your synapse config.
+*   Restart synapse.
+*   Start the bridge:
+    ```
+    npm run start
+    ```
+*   Start a direct chat with the bot user (`@_skypepuppet_bot:domain.tld` unless you changed the config).
+    (Give it some time after the invite, it'll join after a minute maybe.)
+*   Get your Skype username and password as below, and tell the bot user to link your skype account:
+    ```
+    link <username> <password>
+    ```
+*   Tell the bot user to list the available rooms: (also see `help`)
+    ```
+    list
+    ```
+    Clicking rooms in the list will result in you receiving an invite to the bridged room.