From 4792fc8249dc28939bb5df1f62ddcb49d7c975ba Mon Sep 17 00:00:00 2001 From: Dave O'Connor <8017815-gerrowadat@users.noreply.gitlab.com> Date: Sun, 31 Jan 2021 21:15:36 +0000 Subject: [PATCH] Resolve "Add README for CLI" --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 88d3c56..118e385 100644 --- a/README.md +++ b/README.md @@ -33,3 +33,15 @@ asyncio.run(run()) API documentation can be found from various places online or you can request the latest version from support@heatmiser.com + +## neohub_cli.py + +This package includes a CLI for performing common tasks. + +``` +$ neohub_cli.py help # Shows all commands +$ neohub_cli.py help set_time # Displays help for the set_time function +$ neohub_cli.py --hub_ip=myneohub set_time "2021-01-31 15:43:00" # Specify times like this +$ neohub_cli.py --hub_ip=myneohub set_lock 1234 "Living Room" # Name NeoStats like this. +``` +