DGNum/rust-irc
6
0
Fork 0
Code Issues 1 Pull requests 3 Projects Releases Packages Wiki Activity Actions

Added README pointer to configuration fields in the docs.

Browse source
This commit is contained in:
Aaron Weiss 2018-01-27 21:12:56 +01:00
parent 518303a013
commit 2c543e9674
No known key found for this signature in database
GPG key ID: 047D32DF25DC22EF
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -77,7 +77,8 @@ loading of configuration required. However, for convenience, we've also included
loading files with `serde` to write configurations. The default configuration format is TOML, loading files with `serde` to write configurations. The default configuration format is TOML,
though there is optional support for JSON and YAML via the optional `json` and `yaml` features. All though there is optional support for JSON and YAML via the optional `json` and `yaml` features. All
the configuration fields are optional, and can thus be omitted, but a working configuration requires the configuration fields are optional, and can thus be omitted, but a working configuration requires
at least a `server` and `nickname`. at least a `server` and `nickname`. You can find detailed explanations of the configuration format
[here](https://docs.rs/irc/0.12.8/irc/client/data/config/struct.Config.html#fields).
Here's an example of a complete configuration in TOML: Here's an example of a complete configuration in TOML: