diff --git a/README.md b/README.md new file mode 100644 index 0000000..475d0a5 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# Usage + +Unfortunately, you need to run Python as root in order for this to work, since the command line utility that queries the UPS for information requires you to be running as root. + +A safe-ish way of doing this is using pipenv to create a virtual environment and then taking that path and running it as root. + +The resulting command should look something like this: + +`sudo [path to virtual env]/python app.py` + +Open a browser to `localhost:9090` or your host machine's IP at 9090 to view it. \ No newline at end of file