Added config example
This commit is contained in:
parent
ba976d9e12
commit
190ed0639a
2 changed files with 58 additions and 7 deletions
12
README.md
12
README.md
|
@ -30,18 +30,16 @@ Run `cargo build --release`
|
|||
|
||||
## Usage
|
||||
|
||||
Just run `aliveline` by any preferred way.
|
||||
Just run `aliveline` by any preferred way, for example:
|
||||
```
|
||||
$ ./aliveline
|
||||
```
|
||||
|
||||
## Configuration
|
||||
Aliveline tries to find config at `$XDG_CONFIG_DIR/aliveline/config.toml`.
|
||||
If config isn't found, or `$XDG_CONFIG_DIR` is not set, Aliveline uses default values.
|
||||
|
||||
You can configure these values:
|
||||
- `log_path`
|
||||
- Type: `String`
|
||||
- Default: `logs`
|
||||
Path to directory where logs are located.
|
||||
Path may be absolute or relative to config directory.
|
||||
See the example [config.toml](http://2ndbeam.ru/git/2ndbeam/aliveline/src/branch/master/config.toml) for default values.
|
||||
|
||||
## Contribution
|
||||
You can contribute to Aliveline by creating issue on this repository, then we'll discuss it.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue