Updated README to fix typos and describe new changes.
This commit is contained in:
Aaron Weiss
parent
20e7f2fdf5
commit
142a065fb7
1 changed files with 47 additions and 43 deletions
90
README.md
90
README.md
|
|
@ -3,15 +3,15 @@ A robust, thread-safe and async-friendly IRC library in Rust. The client portion
|
|||
[RFC 2812](http://tools.ietf.org/html/rfc2812), [IRCv3.1](http://ircv3.net/irc/3.1.html),
|
||||
[IRCv3.2](http://ircv3.net/irc/3.2.html), and includes some additional, common features. It also
|
||||
features a number of useful built-in features for building a powerful client quickly. The
|
||||
server portion does not exist yet, but hopefully will in the future. You can find up-to-date, ready-to-use documentation
|
||||
online [here](https://docs.rs/irc/). The documentation is generated with the default
|
||||
features. These are, however, strictly optional and can be disabled accordingly.
|
||||
server portion does not exist yet, but hopefully will in the future. You can find up-to-date,
|
||||
ready-to-use documentation online [here](https://docs.rs/irc/). The documentation is generated with
|
||||
the default features. These are, however, strictly optional and can be disabled accordingly.
|
||||
|
||||
## Getting Started ##
|
||||
|
||||
To start using this library with cargo, you can simply add `irc = "0.12.0"` to your dependencies to
|
||||
To start using this library with cargo, you can simply add `irc = "0.12.0"` to your dependencies in
|
||||
your Cargo.toml file. You'll likely want to take a look at some of the examples, as well as the
|
||||
documentation. You'll also be able to find a small template to get a feel for the library.
|
||||
documentation. You'll also be able to find below a small template to get a feel for the library.
|
||||
|
||||
## Getting Started by Example ##
|
||||
|
||||
|
|
@ -64,46 +64,50 @@ fn main() {
|
|||
Like the rest of the IRC crate, configuration is built with flexibility in mind. You can easily
|
||||
create `Config` objects programmatically and choose your own methods for handling any saving or
|
||||
loading of configuration required. However, for convenience, we've also included the option of
|
||||
loading JSON files with `serde` to write configurations. All the fields are optional, and thus
|
||||
any of them can be omitted (though, omitting a nickname or server will cause the program to fail
|
||||
for obvious reasons). That being said, here's an example of a complete configuration:
|
||||
loading files with `serde` to write configurations. By default, we support JSON and TOML. As of
|
||||
0.12.4, TOML is the preferred configuration format. We have bundled a conversion tool as
|
||||
`convertconf` in the examples. In a future version, we will likely disable JSON by default.
|
||||
Additionally, you can enable the optional `yaml` feature to get support for YAML as well. All the
|
||||
configuration fields are optional, and thus any of them can be omitted (though, omitting a nickname
|
||||
or server will cause the program to fail for obvious reasons).
|
||||
|
||||
```json
|
||||
{
|
||||
"owners": [],
|
||||
"nickname": "user",
|
||||
"nick_password": "password",
|
||||
"alt_nicks": ["user_", "user__"],
|
||||
"username": "user",
|
||||
"realname": "Test User",
|
||||
"server": "chat.freenode.net",
|
||||
"port": 6697,
|
||||
"password": "",
|
||||
"use_ssl": true,
|
||||
"cert_path": "cert.der",
|
||||
"encoding": "UTF-8",
|
||||
"channels": ["#rust", "#haskell", "#fake"],
|
||||
"channel_keys": {
|
||||
"#fake": "password"
|
||||
},
|
||||
"umodes": "+RB-x",
|
||||
"user_info": "I'm a test user for the Rust IRC crate.",
|
||||
"version": "irc:git:Rust",
|
||||
"source": "https://github.com/aatxe/irc",
|
||||
"ping_time": 180,
|
||||
"ping_timeout": 10,
|
||||
"burst_window_length": 8,
|
||||
"max_messages_in_burst": 15,
|
||||
"should_ghost": false,
|
||||
"ghost_sequence": [],
|
||||
"options": {
|
||||
"key": "value",
|
||||
"note": "anything you want can be in here!",
|
||||
"and": "you can use it to build your own additional configuration options."
|
||||
}
|
||||
}
|
||||
Here's an example of a complete configuration in TOML:
|
||||
|
||||
```toml
|
||||
owners = []
|
||||
nickname = "user"
|
||||
nick_password = "password"
|
||||
alt_nicks = ["user_", "user__"]
|
||||
username = "user"
|
||||
realname = "Test User"
|
||||
server = "chat.freenode.net"
|
||||
port = 6697
|
||||
password = ""
|
||||
use_ssl = true
|
||||
cert_path = "cert.der"
|
||||
encoding = "UTF-8"
|
||||
channels = ["#rust", "#haskell", "#fake"]
|
||||
umodes = "+RB-x"
|
||||
user_info = "I'm a test user for the Rust IRC crate."
|
||||
version = "irc:git:Rust"
|
||||
source = "https://github.com/aatxe/irc"
|
||||
ping_time = 180
|
||||
ping_timeout = 10
|
||||
burst_window_length = 8
|
||||
max_messages_in_burst = 15
|
||||
should_ghost = false
|
||||
ghost_sequence = []
|
||||
|
||||
[channel_keys]
|
||||
"#fake" = "password"
|
||||
|
||||
[options]
|
||||
note = "anything you want can be in here!"
|
||||
and = "you can use it to build your own additional configuration options."
|
||||
key = "value"
|
||||
```
|
||||
|
||||
## Contributing ##
|
||||
Contributions to this library would be immensely appreciated. Prior to version 0.12.0, this library was public domain. As of 0.12.0, this library is offered under the Mozilla Public License 2.0 whose text can be found in `LICENSE.md`.
|
||||
Contributions to this library would be immensely appreciated. Prior to version 0.12.0, this library
|
||||
was public domain. As of 0.12.0, this library is offered under the Mozilla Public License 2.0 whose
|
||||
text can be found in `LICENSE.md`.
|
||||
|
|
|
|||
Loading…
Reference in a new issue