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

Added more information about specification compliance to README.md.

Browse source
This commit is contained in:
Aaron Weiss 2015-06-07 18:45:59 -04:00
parent 595e75f1e0
commit 3461dc0bc8
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -1,14 +1,15 @@
# irc [![Build Status](https://travis-ci.org/aatxe/irc.svg?branch=master)](https://travis-ci.org/aatxe/irc) [![Crates.io](https://img.shields.io/crates/v/irc.svg)](https://crates.io/crates/irc) # # irc [![Build Status](https://travis-ci.org/aatxe/irc.svg?branch=master)](https://travis-ci.org/aatxe/irc) [![Crates.io](https://img.shields.io/crates/v/irc.svg)](https://crates.io/crates/irc) #
A thread-safe IRC library in Rust. The client portion is compliant with 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 [RFC 2812](http://tools.ietf.org/html/rfc2812), [IRCv3.1](http://ircv3.net/irc/3.1.html),
server portion is still a work in progress. You can find up-to-date, ready-to-use documentation [IRCv3.2](http://ircv3.net/irc/3.2.html), and includes some additional, common features. The server
online [here](http://aatxe.github.io/irc/irc/). The documentation is generated with the portion is still a work in progress. You can find up-to-date, ready-to-use documentation online
default features. These are, however, strictly optional and can be disabled accordingly. [here](http://aatxe.github.io/irc/irc/). The documentation is generated with the default features.
These are, however, strictly optional and can be disabled accordingly.
## Getting Started ## ## Getting Started ##
To start using this library with cargo, you can simply add `irc = "*"` to your dependencies to your To start using this library with cargo, you can simply add `irc = "*"` to your dependencies to your
Cargo.toml file. You'll likely want to take a look at some of the examples, as well as the 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 a small template to get a feel for the library.
## Getting Started with Bots ## ## Getting Started with Bots ##