From 1c8e84862cedf54246a20b2321c41ea77b38e4e1 Mon Sep 17 00:00:00 2001 From: Freyja Odinthrir Date: Tue, 9 Sep 2025 03:45:55 -0700 Subject: [PATCH] Update readme --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9f535f3..12aa3c3 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ - [5. Get your credentials](#5-get-your-credentials) - [Configuration](#configuration) - [Examples](#examples) + - [File](#file) + - [Code](#code) - [Config file](#config-file) - [Usage](#usage) @@ -97,10 +99,22 @@ The device ID, ip address, and local code are required for this to work. They ma ## Examples +### File [example config](config/robovac.conf.example) -- arbitrary config file: `robovac --config=/home/user/robovac.conf` -- argments: `robovac --device_id=DEVICE_ID --ip=192.168.1.1 --local_code=LOCAL_CODE` +### Code + +Set config file to any arbitrary location: + +``` +robovac --config=/home/user/robovac.conf +``` + +Provide credentials inline: + +``` +robovac --device_id=DEVICE_ID --ip=192.168.1.1 --local_code=LOCAL_CODE +``` ### Config file