diff --git a/README.md b/README.md index 0f7a976..37410a2 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,25 @@ -# OVOSSkill +# OVOSSkill - MQ-2 Gas Sensor Reading Introductory Skill so that Skill Authors can see how an OVOS Skill is put together ## About -Information about your skill +Get the PPM value from MQ-2 Sensor using Adafruit's ADS1015 breakout module ## Examples -- "Hello world" -- "How are you?" -- "Thank you" +- read sensor +- gas level +- Get gas level +- read the gas sensor +- What is the gas level? +- What is the gas level in the room? +- Am I in danger of gas poisoning? ## Credits -authorName (@githubUsername) - -## Category - -TODO: +- Michelle T. (@mushie4282) +- Mike Gray (@mikejgray) ## Tags diff --git a/setup.py b/setup.py index a6ef654..8597017 100644 --- a/setup.py +++ b/setup.py @@ -3,8 +3,8 @@ from os import walk, path BASEDIR = path.abspath(path.dirname(__file__)) -URL = "TODO: Add 'repositoryUrl' to .projenrc.json and run pj" -SKILL_CLAZZ = "TODO: Add 'skillClass' to .projenrc.json and run pj" # needs to match __init__.py class name +URL = "https://github.com/CSULB-CECS-Senior-Design/ovos-skill-gas" +SKILL_CLAZZ = "Mq2Sensor" # needs to match __init__.py class name PYPI_NAME = "ovos-skill-gas" # pip install PYPI_NAME # below derived from github url to ensure standard skill_id