README.org

April 9, 2013 ยท View on GitHub

[[https://secure.travis-ci.org/portertech/carrier-pigeon.png]]

  • Install

: gem install carrier-pigeon

  • Usage

: require "carrier-pigeon"

Send a private message

: CarrierPigeon.send( : :uri => "irc://nick:password@irc.domain.com:6667/#channel", : :message => "cooooo, coo coo" : )

Send a notice

: CarrierPigeon.send( : :uri => "irc://nick:password@irc.domain.com:6667/#channel", : :message => "cooooo, coo coo", : :notice => true : )

Use SSL

: CarrierPigeon.send( : :uri => "irc://nick:password@irc.domain.com:6667/#channel", : :message => "coo, secret plan", : :ssl => true : )

Join a channel (required for most Freenode channels)

: CarrierPigeon.send( : :uri => "irc://nick:password@irc.domain.com:6667/#channel", : :message => "cooooo, part of the flock", : :join => true : )

Join a channel that requires a password

: CarrierPigeon.send( : :uri => "irc://nick:password@irc.domain.com:6667/#channel", : :message => "coo, the password is ..." : :channel_password => "secret", : :join => true : )

Identify with NickServ

: CarrierPigeon.send( : :uri => "irc://nick:password@irc.domain.com:6667/#channel", : :message => "nickserv, coo coo", : :nickserv_password => "secret" : )