From 043793aeec7343157ecf7b5d15496566adeb6603 Mon Sep 17 00:00:00 2001 From: Ben Morgan Date: Mon, 21 Aug 2023 18:57:28 -0600 Subject: [PATCH] Update README.md --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 09deb12..0503a41 100644 --- a/README.md +++ b/README.md @@ -32,3 +32,8 @@ To run MetricsAPI you will need to install Flask. MetricsAPI gets its data from shell commands. You will need to install the following with your package manager: `sysstat` `sensors` + +### Try It! +I run the following command to start the API. Keep in mind that I only run this on my local network and the API is not open to the internet. As per Flask documention --app run is not intended for production. You should follow a Flask app deployment procedure (there are tons of them online) if you wish to open your API to the WWW. + +`flask --app main run --host=0.0.0.0`