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

Changed README to reflect a more concrete name.

Browse source
This commit is contained in:
Aaron Weiss 2018-01-30 01:27:23 +01:00
parent 3c9690b2f7
commit 7c53ab861e
No known key found for this signature in database
GPG key ID: 047D32DF25DC22EF
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -1,4 +1,4 @@
# irc [![Build Status][ci-badge]][ci] [![Crates.io][cr-badge]][cr] [![Docs][doc-badge]][doc] [![Built with Spacemacs][bws]][sm] # the irc crate [![Build Status][ci-badge]][ci] [![Crates.io][cr-badge]][cr] [![Docs][doc-badge]][doc] [![Built with Spacemacs][bws]][sm]
[ci-badge]: https://travis-ci.org/aatxe/irc.svg?branch=stable [ci-badge]: https://travis-ci.org/aatxe/irc.svg?branch=stable
[ci]: https://travis-ci.org/aatxe/irc [ci]: https://travis-ci.org/aatxe/irc
@ -33,7 +33,7 @@ use irc::client::prelude::*;
fn main() { fn main() {
let cfg = Config { let cfg = Config {
nickname: Some(format!("irc-rs")), nickname: Some(format!("the-irc-crate")),
client: Some(format!("irc.example.com")), client: Some(format!("irc.example.com")),
channels: Some(vec![format!("#test")]), channels: Some(vec![format!("#test")]),
.. Default::default() .. Default::default()
@ -71,7 +71,7 @@ fn main() {
## Configuration ## ## Configuration ##
Like the rest of the IRC crate, configuration is built with flexibility in mind. You can easily 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 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 of configuration required. However, for convenience, we've also included the option of
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,
@ -97,7 +97,7 @@ cert_path = "cert.der"
encoding = "UTF-8" encoding = "UTF-8"
channels = ["#rust", "#haskell", "#fake"] channels = ["#rust", "#haskell", "#fake"]
umodes = "+RB-x" umodes = "+RB-x"
user_info = "I'm a test user for the Rust IRC crate." user_info = "I'm a test user for the irc crate."
version = "irc:git:Rust" version = "irc:git:Rust"
source = "https://github.com/aatxe/irc" source = "https://github.com/aatxe/irc"
ping_time = 180 ping_time = 180