diff options
| author | Zoffix Znet <cpan@zoffix.com> | 2016-08-02 10:13:51 -0400 |
|---|---|---|
| committer | Zoffix Znet <cpan@zoffix.com> | 2016-08-02 10:13:51 -0400 |
| commit | ed6c6f01bd563df1c4f7ec1a7e6262bffb6c24cc (patch) | |
| tree | 22d90e1c9fa9d271849bd53f605b73b66e9934e6 /docs | |
| parent | 5d193e0c18f747f2f4f71d068f1baa31f94fe3aa (diff) | |
Add support for channel passwords
Closes #18
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/01-basics.md | 2 | ||||
| -rw-r--r-- | docs/03-method-reference.md | 14 |
2 files changed, 12 insertions, 4 deletions
diff --git a/docs/01-basics.md b/docs/01-basics.md index 5aabaca..d7ce0b4 100644 --- a/docs/01-basics.md +++ b/docs/01-basics.md @@ -86,7 +86,7 @@ the original message, prefixed with `You said `. .run with IRC::Client.new: :host<irc.freenode.net> - :channels<#perl6bot #zofbot> + :channels('#perl6bot', '#zofbot', '#myown' => 's3cret') :debug :plugins( class { method irc-to-me ($e) { "You said $e.text()"} } diff --git a/docs/03-method-reference.md b/docs/03-method-reference.md index 7b6ddb6..9c5f1fa 100644 --- a/docs/03-method-reference.md +++ b/docs/03-method-reference.md @@ -345,8 +345,9 @@ The label of this server. #### `.channels` -A list of strings containing all the channels the client is in on this -server. +A list of `Str` or `Pair` containing all the channels the client is in on this +server. Pairs represent channels with channel passwords, where the key is +the channel and the value is its password. #### `.nick` @@ -463,7 +464,14 @@ Instantiates a new `IRC::Client` object. Takes the following named arguments: ##### `:channels` -A list of IRC channels to join. **Defaults to:** `#perl6` +```perl6 + :channels('#perl6bot', '#zofbot', '#myown' => 's3cret') +``` + +A list of `Str` or `Pair` containing the channels to join. +Pairs represent channels with channel passwords, where the key is +the channel and the value is its password. +**Defaults to:** `#perl6` ##### `:debug` |