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

Updated README.md.

Browse source
This commit is contained in:
Aaron Weiss 2015-01-13 02:57:40 -05:00
parent c9a767c8ff
commit 6191e53350
1 changed files with 11 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -1,21 +1,23 @@
# irc [![Build Status](https://travis-ci.org/aatxe/irc.svg?branch=master)](https://travis-ci.org/aatxe/irc) #
A thread-safe IRC library in Rust based on iterators. It's hopefully compliant with
[RFC 2812](http://tools.ietf.org/html/rfc2812). You can find up-to-date, ready-to-use documentation
online [here](http://www.rust-ci.org/aatxe/irc/doc/irc/). The documentation is generated
with the default features. These are, however, strictly optional and can be disabled by the
end-user.
A thread-safe IRC library in Rust. The client portion is compliant with
[RFC 2812](http://tools.ietf.org/html/rfc2812) and includes some additional, common features. The
server portion is still a work in progress. You can find up-to-date, ready-to-use documentation
online [here](http://www.rust-ci.org/aatxe/irc/doc/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 = "*"` to your dependencies to your
Cargo.toml file. From there, you can look to the examples and the documentation to see how to
proceed. Making a simple bot is easy though:
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.
## Getting Started with Bots ##
```rust
extern crate irc;
use irc::server::{IrcServer, Server};
use irc::server::utils::Wrapper;
use irc::client::server::{IrcServer, Server};
use irc::client::server::utils::Wrapper;
fn main() {
let irc_server = IrcServer::new("config.json").unwrap();