diff --git a/README.md b/README.md
index 6856f7a..2bad231 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,14 @@
-[](https://opensource.org/licenses/MIT) [](https://github.com/smartgic/mycroft-magicmirror-wakeword-skill/pulls) [](https://openvoiceos.org) [](https://discord.gg/Vu7Wmd9j)
+[](https://opensource.org/licenses/MIT) [](https://github.com/smartgic/skill-ovos-mm-wakeword/pulls) [](https://openvoiceos.org) [](https://discord.gg/Vu7Wmd9j)
# 
MagicMirror² wake word detection
-Image and message display on MagicMirror² when Open Voice OS is listening.
+Display an image and a message 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 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.
+This skill interacts with MagicMirror² to let you know if OVOS is listening. When a wake word is detected an image and message are display on the screen and when the recording is done image and the message disappear.
@@ -19,14 +19,19 @@ There is no example because there is no voice interaction with Open Voice OS.
## Installation
```shell
-$ pip install ovos-magicmirror-wakeword-skill
+$ pip install git+https://github.com/smartgic/skill-ovos-mm-wakeword
```
## Configuration
-This skill utilizes the `settings.json` file which allows you to configure this skill via `home.mycroft.ai` after a few seconds of having the skill installed you should see something like below in the https://home.mycroft.ai/#/skill location:
+This skill utilizes the `~/.config/mycroft/skills/skill-ovos-mm-wakeword.smartgic/settings.json` file which allows you to configure this skill.
-
+```json
+{
+ "url": "http://mm.home.lan",
+ "key": "en323q9WBNMK3Q04WIPNEAsdfhesammhp44"
+}
+```
Fill this out with your appropriate information and hit save.
@@ -51,4 +56,3 @@ Smart'Gic
#wakeword
#raspberrypi
#smarthome
-#picroft
diff --git a/docs/magicmirror-wakeword-config.png b/docs/magicmirror-wakeword-config.png
deleted file mode 100644
index cf440ca..0000000
Binary files a/docs/magicmirror-wakeword-config.png and /dev/null differ
diff --git a/docs/screenshot.png b/docs/screenshot.png
index c4c3952..9251a5d 100644
Binary files a/docs/screenshot.png and b/docs/screenshot.png differ
diff --git a/setup.py b/setup.py
index bfc7f79..21f3842 100644
--- a/setup.py
+++ b/setup.py
@@ -1,6 +1,6 @@
#!/usr/bin/env python3
-from setuptools import setup
from os import walk, path
+from setuptools import setup
BASEDIR = path.abspath(path.dirname(__file__))
URL = "https://github.com/smartgic/skill-ovos-mm-wakeword"
@@ -22,8 +22,8 @@ def get_version():
version = None
version_file = path.join(BASE_PATH, "version.py")
major, minor, build, alpha = (None, None, None, None)
- with open(version_file, encoding="utf-8") as file:
- for line in file:
+ with open(version_file, encoding="utf-8") as file_version:
+ for line in file_version:
if "VERSION_MAJOR" in line:
major = line.split("=")[1].strip()
elif "VERSION_MINOR" in line:
@@ -64,8 +64,8 @@ def find_resource_files():
return package_data
-with open("README.md", "r", encoding="utf-8") as file:
- long_description = file.read()
+with open("README.md", "r", encoding="utf-8") as file_readme:
+ long_description = file_readme.read()
setup(
name=PYPI_NAME,