diff --git a/README.md b/README.md index 7b209af..e401f96 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,25 @@ # Simple OVOS Texting Skill -Introductory Skill so that Skill Authors can see how an OVOS Skill is put together +In order to enable SMS ability, you need a cellular module. So far this skill works with Waveshare's SIM7600X HAT. This is a skill rather than a plugin because of it simple task to only text one phone number. Also, you need to define the word "emergency" as one of OVOS's hotword. -## About +``` +"hotwords":{ + "Emergency":{ + "module":"ovos-ww-plugin-vosk", + "samples":["emergency"], + "lang": "en", + "rule":"fuzzy", + "listen":false, + "active":true, + "bus_event":"text.emergency" + } + } +``` -The skill should send a text to a phone number when the user says the word emergency. +## About -## Tags +The skill send a text to a phone number when the user says the word emergency. -ovos skill +## Credits +Michelle Tran +Mike Gray's skill generator - https://github.com/mikejgray/ovos-skill-projen