extend usage docs in README
This commit is contained in:
parent
13f4a5b239
commit
196ddd6777
|
@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
### Changed
|
||||||
|
- Improved usage information in the README
|
||||||
|
|
||||||
## [0.1.0] - 2020-04-15
|
## [0.1.0] - 2020-04-15
|
||||||
Initial release. Supports updating OVH DynHost entries.
|
Initial release. Supports updating OVH DynHost entries.
|
||||||
|
|
|
@ -14,7 +14,10 @@ cargo install --path .
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
For usage information, run `ovh-dynhost --help`.
|
The basic mode of operation is `ovh-dynhost /path/to/config.toml`.
|
||||||
|
For more usage information, run `ovh-dynhost --help`.
|
||||||
|
|
||||||
|
You can find a sample configuration file in this repo, it's called `config.sample.toml`.
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
|
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
|
||||||
|
|
Loading…
Reference in a new issue