From 2c543e967492ee682f0d347de02944ae064000ec Mon Sep 17 00:00:00 2001 From: Aaron Weiss Date: Sat, 27 Jan 2018 21:12:56 +0100 Subject: [PATCH] Added README pointer to configuration fields in the docs. --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 39858ba..1fd7117 100644 --- a/README.md +++ b/README.md @@ -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, 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 -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: