forked from github.com/eufy_robovac
Update readme
This commit is contained in:
18
README.md
18
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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user