Merge pull request #1 from smartgic/dev

Sync

README.md

@@ -1,30 +1,25 @@
-
-[![Build Status](https://travis-ci.com/smartgic/mycroft-magicmirror-wakeword-skill.svg?branch=20.8.1)](https://travis-ci.com/github/smartgic/mycroft-magicmirror-wakeword-skill) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![contributions welcome](https://img.shields.io/badge/contributions-welcome-pink.svg?style=flat)](https://github.com/smartgic/mycroft-magicmirror-wakeword-skill/pulls) [![Skill: MIT](https://img.shields.io/badge/mycroft.ai-skill-blue)](https://mycroft.ai) [![Discord](https://img.shields.io/discord/809074036733902888)](https://discord.gg/Vu7Wmd9j) 
-
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![contributions welcome](https://img.shields.io/badge/contributions-welcome-pink.svg?style=flat)](https://github.com/smartgic/mycroft-magicmirror-wakeword-skill/pulls) [![Skill: MIT](https://img.shields.io/badge/ovos-skill-blue)](https://openvoiceos.org) [![Discord](https://img.shields.io/discord/809074036733902888)](https://discord.gg/Vu7Wmd9j)
 
 # <img src="docs/magicmirror.png" card_color="#0000" width="150" height="30" style="vertical-align:bottom"/> MagicMirror² wake word detection
 
-Image and message indicators Mycroft AI on MagicMirrot²
+Image and message display on MagicMirror² when Open Voice OS is listening.
 
 ## About
 
 [MagicMirror²](https://magicmirror.builders/) is an open source modular smart mirror platform. With a growing list of installable modules, the MagicMirror² allows you to convert your hallway or bathroom mirror into your personal assistant.
 
-This skill interacts with MagicMirror² to let you know if Mycroft is listening. When a wake word is detected the an image and message are display on the screen and when the recording is done image and the message disappear.
+This skill interacts with MagicMirror² to let you know if OVOS is listening. When a wake word is detected the an image and message are display on the screen and when the recording is done image and the message disappear.
 
-<img src='docs/screenshot.png.png' width='450'/>
+<img src='docs/screenshot.png' width='450'/>
 
 ## Examples
 
-There is no example because there is no voice interaction with Mycroft AI.
+There is no example because there is no voice interaction with Open Voice OS.
 
 ## Installation
 
-Make sure to be within the Mycroft `virtualenv` before running the `msm` command.
-
-```
-$ . mycroft-core/venv-activate.sh
-$ msm install https://github.com/smartgic/mycroft-magicmirror-wakeword-skill.git
+```shell
+$ pip install ovos-magicmirror-wakeword-skill
 ```
 
 ## Configuration
@@ -35,6 +30,12 @@ This skill utilizes the `settings.json` file which allows you to configure this
 
 Fill this out with your appropriate information and hit save.
 
+## MagicMirror configuration
+
+In order to reach the `/ovos` route on your MagicMirror, you need to allow the remote connection for a specific IP address or for a network range.
+
+Please have a look here: https://github.com/smartgic/MMM-ovos-wakeword
+
 ## Credits
 
 Smart'Gic